com.genesyslab.ail
Interface ResourceManager


public interface ResourceManager

Manager of agent resources. An agent can customize its application (e.g. agent's dictionary).

Note: If the DATABASE service is not available, that is, if UCS is not connected, you cannot get features associated with UCS, that is, this resource manager.


Method Summary
 void deleteResourceProperty(java.lang.String aPersonId, java.lang.String aKey)
          Deletes a resource for an agent.
 java.util.Collection getResourceProperties(java.lang.String aPersonId)
          Gets a collection of ResourceProperty for an agent.
 ResourceProperty getResourceProperty(java.lang.String aPersonId, java.lang.String aKey)
          Gets a ResourceProperty for an agent.
 void setResourceProperty(java.lang.String aPersonId, java.lang.String aKey, byte[] aValue)
          Sets a binary resource for an agent.
 void setResourceProperty(java.lang.String aPersonId, java.lang.String aKey, java.lang.String aValue)
          Sets a string resource for an agent.
 

Method Detail

getResourceProperty

ResourceProperty getResourceProperty(java.lang.String aPersonId,
                                     java.lang.String aKey)
                                     throws RequestFailedException
Gets a ResourceProperty for an agent.

Parameters:
aPersonId - ID (username) of person (agent) as String.
aKey - resource identifier as String.
Returns:
a resource as ResourceProperty.
Throws:
RequestFailedException - if request does not perform.
InvalidParameterException - if method parameters are wrong.

getResourceProperties

java.util.Collection getResourceProperties(java.lang.String aPersonId)
                                           throws RequestFailedException
Gets a collection of ResourceProperty for an agent.

Parameters:
aPersonId - ID (username) of person (agent) as String.
Returns:
a Collection of ResourceProperty.
Throws:
RequestFailedException - if request does not perform.
InvalidParameterException - if method parameters are wrong.

setResourceProperty

void setResourceProperty(java.lang.String aPersonId,
                         java.lang.String aKey,
                         byte[] aValue)
                         throws RequestFailedException
Sets a binary resource for an agent.

Parameters:
aPersonId - ID (username) of person (agent) as String.
aKey - resource identifier as String.
aValue - resource value as a byte array.
Throws:
RequestFailedException - if request does not perform.
InvalidParameterException - if method parameters are wrong.

setResourceProperty

void setResourceProperty(java.lang.String aPersonId,
                         java.lang.String aKey,
                         java.lang.String aValue)
                         throws RequestFailedException
Sets a string resource for an agent.

Parameters:
aPersonId - ID (username) of person (agent) as String.
aKey - resource identifier as String.
aValue - resource value as a String.
Throws:
RequestFailedException - if request does not perform.
InvalidParameterException - if method parameters are wrong.

deleteResourceProperty

void deleteResourceProperty(java.lang.String aPersonId,
                            java.lang.String aKey)
                            throws RequestFailedException
Deletes a resource for an agent.

Parameters:
aPersonId - ID (username) of person (agent) as String.
aKey - resource identifier as String.
Throws:
RequestFailedException - if request does not perform.
InvalidParameterException - if method parameters are wrong.