Skip navigation links

waggle.common.modules.properties
Interface XPropertiesModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XPropertiesModule

public static interface XPropertiesModule.Server

extends XAPIInterface.Server

Server interface for the Properties Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

List<XPropertyInfo>	getMatchingProperties(XObjectID propertyID, String pattern) Get all shared property values that match the given pattern.
List<XPropertyInfo>	getMatchingUserProperties(XObjectID propertyID, String pattern) Get all per User property values that match the given pattern.
List<XPropertyInfo>	getProperties(XObjectID propertyID) Get all shared property values.
Object	getProperty(XObjectID propertyID, String propertyName) Get a shared property value.
Collection<String>	getPropertyNames(XObjectID propertyID) Set of all shared property names.
List<XPropertyInfo>	getSpecifiedProperties(XObjectID propertyID, List<String> propertyNames) Get specified shared property values.
List<XPropertyInfo>	getSpecifiedUserProperties(XObjectID propertyID, List<String> propertyNames) Get all specified per User property values.
List<XPropertyInfo>	getUserProperties(XObjectID propertyID) Get all per User property values.
Object	getUserProperty(XObjectID propertyID, String propertyName) Get a per User property value.
Collection<String>	getUserPropertyNames(XObjectID propertyID) Set of all per User property names.
void	removeProperties(XObjectID propertyID, List<String> propertyNames) Remove a set of shared properties and their values.
void	removeProperty(XObjectID propertyID, String propertyName) Remove a shared property and its value.
void	removeUserProperties(XObjectID propertyID, List<String> propertyNames) Remove a set of per User properties and their values.
void	removeUserProperty(XObjectID propertyID, String propertyName) Remove a per User property and its value.
void	setProperties(XObjectID propertyID, List<XPropertyInfo> propertyInfos) Set a shared property value.
void	setProperty(XObjectID propertyID, String propertyName, String propertyValue) Set a shared property value.
void	setUserProperties(XObjectID propertyID, List<XPropertyInfo> propertyInfos) Set a per User property value.
void	setUserProperty(XObjectID propertyID, String propertyName, String propertyValue) Set a per User property value.

Method Detail

setProperty

void setProperty(XObjectID propertyID,
                 String propertyName,
                 String propertyValue)

Set a shared property value.

Parameters:

propertyID - The Property object ID.

propertyName - The property name to set.

propertyValue - The value.

setProperties

void setProperties(XObjectID propertyID,
                   List<XPropertyInfo> propertyInfos)

Set a shared property value.

Parameters:

propertyID - The Property object ID.

propertyInfos - The properties to set.

getProperty

Object getProperty(XObjectID propertyID,
                   String propertyName)

Get a shared property value.

Parameters:

propertyID - The Property object ID.

propertyName - The property name to get

Returns:

The value.

getProperties

List<XPropertyInfo> getProperties(XObjectID propertyID)

Get all shared property values.

Parameters:

propertyID - The Property object ID.

Returns:

The list of properties.

getSpecifiedProperties

List<XPropertyInfo> getSpecifiedProperties(XObjectID propertyID,
                                           List<String> propertyNames)

Get specified shared property values.

Parameters:

propertyID - The Property object ID.

propertyNames - The Property names.

Returns:

The list of matching properties.

getMatchingProperties

List<XPropertyInfo> getMatchingProperties(XObjectID propertyID,
                                          String pattern)

Get all shared property values that match the given pattern. The pattern is used as a simple prefix match. If an existing property name starts with the pattern, then it's returned.

Parameters:

propertyID - The Property object ID.

pattern - The pattern to match.

Returns:

The list of matching properties.

getPropertyNames

Collection<String> getPropertyNames(XObjectID propertyID)

Set of all shared property names.

Parameters:

propertyID - The Property object ID.

Returns:

Set of all property names.

removeProperty

void removeProperty(XObjectID propertyID,
                    String propertyName)

Remove a shared property and its value.

Parameters:

propertyID - The Property object ID.

propertyName - The property name to remove.

removeProperties

void removeProperties(XObjectID propertyID,
                      List<String> propertyNames)

Remove a set of shared properties and their values.

Parameters:

propertyID - The Property object ID.

propertyNames - The property names to remove.

setUserProperty

void setUserProperty(XObjectID propertyID,
                     String propertyName,
                     String propertyValue)

Set a per User property value.

Parameters:

propertyID - The Property object ID.

propertyName - The property name to set.

propertyValue - The value.

setUserProperties

void setUserProperties(XObjectID propertyID,
                       List<XPropertyInfo> propertyInfos)

Set a per User property value.

Parameters:

propertyID - The Property object ID.

propertyInfos - The properties to set.

getUserProperty

Object getUserProperty(XObjectID propertyID,
                       String propertyName)

Get a per User property value.

Parameters:

propertyID - The Property object ID.

propertyName - The property name to get

Returns:

The value.

getUserProperties

List<XPropertyInfo> getUserProperties(XObjectID propertyID)

Get all per User property values.

Parameters:

propertyID - The Property object ID.

Returns:

The list of properties.

getSpecifiedUserProperties

List<XPropertyInfo> getSpecifiedUserProperties(XObjectID propertyID,
                                               List<String> propertyNames)

Get all specified per User property values.

Parameters:

propertyID - The Property object ID.

propertyNames - The Property names.

Returns:

The list of matching properties.

getMatchingUserProperties

List<XPropertyInfo> getMatchingUserProperties(XObjectID propertyID,
                                              String pattern)

Get all per User property values that match the given pattern. The pattern is used as a simple prefix match. If an existing property name starts with the pattern, then it's returned.

Parameters:

propertyID - The Property object ID.

pattern - The pattern to match.

Returns:

The list of matching properties.

getUserPropertyNames

Collection<String> getUserPropertyNames(XObjectID propertyID)

Set of all per User property names.

Parameters:

propertyID - The Property object ID.

Returns:

Set of all property names.

removeUserProperty

void removeUserProperty(XObjectID propertyID,
                        String propertyName)

Remove a per User property and its value.

Parameters:

propertyID - The Property object ID.

propertyName - The property name to remove.

removeUserProperties

void removeUserProperties(XObjectID propertyID,
                          List<String> propertyNames)

Remove a set of per User properties and their values.

Parameters:

propertyID - The Property object ID.

propertyNames - The property names to remove.

Skip navigation links