com.pega.pegarules.pub.presence

Interface PresenceService

public interface PresenceService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.util.List<PresenceRecord>	queryPresence(java.lang.String queryString, java.util.List<PresenceQueryClause> queryClauses, java.lang.String categoryToReturn) API queries presence information and returns matching presence records
boolean	setAttributes(java.lang.String operatorId, java.lang.String customCategoryName, java.util.Map<java.lang.String,java.lang.String> customAttributeNameAndValues, java.util.Map<java.lang.String,java.lang.String> standardAttributeNameAndValues) Modifies presence record for the operator specified
boolean	setAttributesWithoutOverwrite(java.lang.String operatorId, java.lang.String customCategoryName, java.util.Map<java.lang.String,java.lang.String> customAttributeNameAndValues, java.util.Map<java.lang.String,java.lang.String> standardAttributeNameAndValues) Variant of setAttributes(String, String, Map, Map) to prevent overwrite.
void	setCurrentRequestorStateAsDisconnected() Sets the presence session state of current requestor to DISCONNECTED

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

Method Detail

setAttributes

boolean setAttributes(java.lang.String operatorId,
                      java.lang.String customCategoryName,
                      java.util.Map<java.lang.String,java.lang.String> customAttributeNameAndValues,
                      java.util.Map<java.lang.String,java.lang.String> standardAttributeNameAndValues)
               throws PresenceException

Modifies presence record for the operator specified

Parameters:

operatorId - : operator whose presence record should be modified.

customCategoryName - : category of custom attributes

customAttributeNameAndValues - : map of name and values for attributes under above category. If the category or attribute do not exist in a presence record, new one is created.

standardAttributeNameAndValues - : map of name and values for attributes under standard category. If the standard attribute does not exist or is only readable call , then this input is considered as invalid input.

Returns:

true indicates that presence record is successfully updated.

Throws:

PresenceException - indicates invalid input or an error

setAttributesWithoutOverwrite

boolean setAttributesWithoutOverwrite(java.lang.String operatorId,
                                      java.lang.String customCategoryName,
                                      java.util.Map<java.lang.String,java.lang.String> customAttributeNameAndValues,
                                      java.util.Map<java.lang.String,java.lang.String> standardAttributeNameAndValues)
                               throws PresenceException

Variant of setAttributes(String, String, Map, Map) to prevent overwrite. If any of the attribute to modify is previously set for the operator, then presence record of the operator is not modified. Method returns false in this case.

Parameters:

operatorId -

customCategoryName -

customAttributeNameAndValues -

standardAttributeNameAndValues -

Returns:

true indicates that presence record is successfully updated.

Throws:

PresenceException - indicates invalid input or an error

queryPresence

java.util.List<PresenceRecord> queryPresence(java.lang.String queryString,
                                             java.util.List<PresenceQueryClause> queryClauses,
                                             java.lang.String categoryToReturn)
                                      throws PresenceException

API queries presence information and returns matching presence records

Parameters:

categoryToReturn - Category of attributes to be returned for matching records. This should match with category if mentioned in the conditions array.

queryString - This expression joins PresenceQueryClauses mentioned in queryClauses parameter using predefined tokens: AND, OR, ), (, space
Each query clause is identified using queryclauseIdentifiers mentioned in PresenceQueryClause.
PresenceException is thrown for invalid queryString.

queryClauses - array of PresenceQueryClause.

Returns:

PresenceRecord[] returns array of matching records. Empty array indicates zero records.

Throws:

PresenceException - indicates invalid input or an error

setCurrentRequestorStateAsDisconnected

void setCurrentRequestorStateAsDisconnected()

Sets the presence session state of current requestor to DISCONNECTED