ResourceGatewayClientAdapter (YAWL Version 4.3)

java.lang.Object
- org.yawlfoundation.yawl.resourcing.rsInterface.ResourceGatewayClientAdapter

Direct Known Subclasses:

ExampleAdapter
```
public class ResourceGatewayClientAdapter
extends java.lang.Object
```
This adapter class adds a transformation layer to the resource gateway client, effectively reconstituting the Strings returned from the gateway into java objects. Author: Michael Adams Date: 26/10/2007

Field Summary

Fields
Modifier and Type	Field and Description
`protected ResourceMarshaller`	`_marshaller`
`protected ResourceGatewayClient`	`_rgclient`
`protected java.lang.String`	`_uri`
`protected XNodeParser`	`_xnodeParser`
`static java.lang.String`	`JSON_FORMAT`
`static java.lang.String`	`XML_FORMAT`

Constructor Summary

Constructors
Constructor and Description

ResourceGatewayClientAdapter()

ResourceGatewayClientAdapter(java.lang.String uri)

Constructors
Constructor and Description
`ResourceGatewayClientAdapter()`
`ResourceGatewayClientAdapter(java.lang.String uri)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`addCapability(Capability cap, java.lang.String handle)` Adds a new capability to the service's org data
`java.lang.String`	`addNonHumanCategory(java.lang.String category, java.lang.String handle)` Adds a new NonHumanResource category
`java.lang.String`	`addNonHumanResource(NonHumanResource resource, java.lang.String handle)` Adds a new NonHumanResource to the service's org data
`boolean`	`addNonHumanSubCategory(java.lang.String id, java.lang.String subcategory, java.lang.String handle)` Adds a new NonHumanResource category
`boolean`	`addNonHumanSubCategoryByName(java.lang.String category, java.lang.String subcategory, java.lang.String handle)` Adds a new NonHumanResource category
`java.lang.String`	`addOrgGroup(OrgGroup group, java.lang.String handle)` Adds a new org group to the service's org data
`java.lang.String`	`addParticipant(Participant p, boolean encryptPassword, java.lang.String handle)` Adds a new participant to the service's org data
`java.lang.String`	`addParticipant(Participant p, java.lang.String handle)` Adds a new participant to the service's org data
`java.lang.String`	`addParticipantToCapability(Participant p, Capability cap, java.lang.String handle)` Adds the specified Participant to the specified Capability
`java.lang.String`	`addParticipantToPosition(Participant p, Position pos, java.lang.String handle)` Adds the specified Participant to the specified Position
`java.lang.String`	`addParticipantToRole(Participant p, Role role, java.lang.String handle)` Adds the specified Participant to the specified Role
`java.lang.String`	`addPosition(Position pos, java.lang.String handle)` Adds a new position to the service's org data
`java.lang.String`	`addRole(Role role, java.lang.String handle)` Adds a new role to the service's org data
`boolean`	`checkConnection(java.lang.String handle)` Checks that the connection to the service is valid
`java.lang.String`	`connect(java.lang.String userid, java.lang.String password)` Attempts to connect to the service
`void`	`disconnect(java.lang.String handle)` Disconnects a session from the service
`java.util.Set<Participant>`	`getActiveParticipants(java.lang.String handle)` Gets the set of Participants that are currently logged on
`java.util.List<java.lang.String>`	`getAllNonHumanResourceNames(java.lang.String handle)` Gets the name of each NonHumanResource
`java.util.List<AbstractSelector>`	`getAllocators(java.lang.String handle)` Gets a complete list of available Allocator objects
`java.util.List<java.lang.String>`	`getAllParticipantNames(java.lang.String handle)` Gets the full name of each participant
`java.util.List<java.lang.String>`	`getAllRoleNames(java.lang.String handle)` Gets the name of each role
`java.util.List`	`getCapabilities(java.lang.String handle)` Gets a complete list of available Capability objects
`Capability`	`getCapability(java.lang.String id, java.lang.String handle)` Gets the Capability with the specified id
`Capability`	`getCapabilityByName(java.lang.String name, java.lang.String handle)` Gets the Capability with the specified name
`java.util.Map<java.lang.String,java.lang.String>`	`getCapabilityIdentifiers(java.lang.String handle)` Gets the id and name of every Capability
`java.lang.String`	`getCapabilityIdentifiersToJSON(java.lang.String handle)` Gets the id and name of every Capability in JSON format
`ResourceGatewayClient`	`getClient()`
`java.lang.String`	`getClientURI()`
`java.util.Map<java.lang.String,java.lang.String>`	`getCodeletMap(java.lang.String handle)`
`java.util.List<YParameter>`	`getCodeletParameters(java.lang.String codeletName, java.lang.String handle)`
`java.util.List<CodeletInfo>`	`getCodelets(java.lang.String handle)` Gets a complete list of available codelets
`java.util.List<AbstractSelector>`	`getConstraints(java.lang.String handle)` Gets a complete list of available Constraint objects
`java.util.List<AbstractSelector>`	`getFilters(java.lang.String handle)` Gets a complete list of available Filter objects
`java.util.List<NonHumanCategory>`	`getNonHumanCategories(java.lang.String handle)` Gets the list of all NonHumanCategory objects known to the Resource Service
`java.lang.String`	`getNonHumanCategoriesToJSON(java.lang.String handle)` Gets the list of all NonHumanResource category names in JSON format
`NonHumanCategory`	`getNonHumanCategory(java.lang.String id, java.lang.String handle)` Gets the NonHumanCategory with the specified id
`NonHumanCategory`	`getNonHumanCategoryByName(java.lang.String name, java.lang.String handle)` Gets the NonHumanCategory with the specified name
`java.util.Map<java.lang.String,java.util.Set<java.lang.String>>`	`getNonHumanCategorySet(java.lang.String handle)` Gets the list of all NonHumanResource category names and the subcategories of each
`NonHumanResource`	`getNonHumanResource(java.lang.String id, java.lang.String handle)` Gets the NonHumanResource with the specified id
`NonHumanResource`	`getNonHumanResourceByName(java.lang.String name, java.lang.String handle)` Gets the NonHumanResource with the specified name
`java.util.Map<java.lang.String,java.lang.String>`	`getNonHumanResourceIdentifiers(java.lang.String handle)` Gets the id and name of every NonHumanResource
`java.lang.String`	`getNonHumanResourceIdentifiersToJSON(java.lang.String handle)` Gets the id and name of every NonHumanResource in JSON format
`java.util.List<NonHumanResource>`	`getNonHumanResources(java.lang.String handle)` Gets a complete list of available NonHumanResource objects
`java.util.List<java.lang.String>`	`getNonHumanSubCategories(java.lang.String id, java.lang.String handle)` Gets the list of all the subcategory names of a NonHumanResource category
`java.util.List<java.lang.String>`	`getNonHumanSubCategoriesByName(java.lang.String category, java.lang.String handle)` Gets the list of all the subcategory names of a NonHumanResource category
`java.lang.String`	`getNonHumanSubCategoriesToJSON(java.lang.String id, java.lang.String handle)` Gets the list of all the subcategory names of a NonHumanResource category in JSON format
`java.lang.String`	`getNonHumanSubCategoriesToJSONByName(java.lang.String category, java.lang.String handle)` Gets the list of all the subcategory names of a NonHumanResource category in JSON format
`OrgGroup`	`getOrgGroup(java.lang.String id, java.lang.String handle)` Gets the OrgGroup with the specified id
`OrgGroup`	`getOrgGroupByName(java.lang.String name, java.lang.String handle)` Gets the OrgGroup with the specified name
`java.util.Map<java.lang.String,java.lang.String>`	`getOrgGroupIdentifiers(java.lang.String handle)` Gets the id and name of every OrgGroup
`java.lang.String`	`getOrgGroupIdentifiersToJSON(java.lang.String handle)` Gets the id and name of every OrgGroup in JSON format
`java.util.List`	`getOrgGroups(java.lang.String handle)` Gets a complete list of available OrgGroup objects
`Participant`	`getParticipant(java.lang.String pid, java.lang.String handle)` Gets a particular Participant
`java.util.List`	`getParticipantCapabilities(java.lang.String pid, java.lang.String handle)` Gets a list of all capabilities held by the specified participant
`Participant`	`getParticipantFromUserID(java.lang.String userID, java.lang.String handle)` Gets the Participant with the specified user id
`java.util.Map<java.lang.String,java.lang.String>`	`getParticipantIdentifiers(ResourceDataSet.Identifier identifier, java.lang.String handle)` Gets the id and chosen name value of every Participant
`java.util.Map<java.lang.String,java.lang.String>`	`getParticipantIdentifiers(java.lang.String handle)` Gets the id and full name of every Participant
`java.lang.String`	`getParticipantIdentifiersToJSON(ResourceDataSet.Identifier identifier, java.lang.String handle)` Gets the id and chosen name value of every Participant in JSON format
`java.lang.String`	`getParticipantIdentifiersToJSON(java.lang.String handle)` Gets the id and full name of every Participant in JSON format
`java.util.List`	`getParticipantPositions(java.lang.String pid, java.lang.String handle)` Gets a list of all positions held by the specified participant
`java.util.List`	`getParticipantRoles(java.lang.String pid, java.lang.String handle)` Gets a list of all roles 'occupied' by the specified participant
`java.util.List<Participant>`	`getParticipants(java.lang.String handle)` Gets a complete list of available Participant objects
`java.util.Set<Participant>`	`getParticipantsWithCapability(java.lang.String capabilityName, java.lang.String handle)` Gets the set of Participants that hold the named capability
`java.util.Set<Participant>`	`getParticipantsWithPosition(java.lang.String positionName, java.lang.String handle)` Gets the set of Participants that 'occupy' the named position
`java.util.Set<Participant>`	`getParticipantsWithRole(java.lang.String roleName, java.lang.String handle)` Gets the set of Participants that 'occupy' the named role
`Position`	`getPosition(java.lang.String id, java.lang.String handle)` Gets the Position with the specified id
`Position`	`getPositionByName(java.lang.String name, java.lang.String handle)` Gets the Position with the specified name
`java.util.Map<java.lang.String,java.lang.String>`	`getPositionIdentifiers(java.lang.String handle)` Gets the id and name of every Position
`java.lang.String`	`getPositionIdentifiersToJSON(java.lang.String handle)` Gets the id and name of every Position in JSON format
`java.util.List`	`getPositions(java.lang.String handle)` Gets a complete list of available Position objects
`java.util.Set<java.lang.String>`	`getReferencedParticipantIDs(java.lang.String anyID, java.lang.String handle)` Gets a set of participant ids referenced by the id string argument
`Role`	`getRole(java.lang.String id, java.lang.String handle)` Gets the Role with the specified id
`Role`	`getRoleByName(java.lang.String name, java.lang.String handle)` Gets the Role with the specified name
`java.util.Map<java.lang.String,java.lang.String>`	`getRoleIdentifiers(java.lang.String handle)` Gets the id and name of every Role
`java.lang.String`	`getRoleIdentifiersToJSON(java.lang.String handle)` Gets the id and name of every Role in JSON format
`java.util.List`	`getRoles(java.lang.String handle)` Gets a complete list of available Role objects
`UserPrivileges`	`getUserPrivileges(java.lang.String id, java.lang.String handle)` Gets the UserPrivileges of the Participant with the specified id
`boolean`	`isKnownCapability(java.lang.String capabilityID, java.lang.String handle)` Checks if an id corresponds to a capability id known to the service
`boolean`	`isKnownNonHumanCategory(java.lang.String id, java.lang.String handle)` Checks if an id corresponds to a NonHumanCategory id known to the service
`boolean`	`isKnownNonHumanResource(java.lang.String id, java.lang.String handle)` Checks if an id corresponds to a NonHumanResource id known to the service
`boolean`	`isKnownOrgGroup(java.lang.String groupID, java.lang.String handle)` Checks if an id corresponds to a OrgGroup id known to the service
`boolean`	`isKnownParticipant(java.lang.String participantID, java.lang.String handle)` Checks if an id corresponds to a participant id known to the service
`boolean`	`isKnownPosition(java.lang.String positionID, java.lang.String handle)` Checks if an id corresponds to a position id known to the service
`boolean`	`isKnownRole(java.lang.String roleID, java.lang.String handle)` Checks if an id corresponds to a role id known to the service
`java.lang.String`	`removeCapability(Capability cap, java.lang.String handle)` Removes (deletes) the specified Capability from the service's org data
`boolean`	`removeNonHumanCategory(java.lang.String id, java.lang.String handle)` Removes a category of the list of NonHumanResource categories
`boolean`	`removeNonHumanCategoryByName(java.lang.String name, java.lang.String handle)` Removes a category of the list of NonHumanResource categories
`java.lang.String`	`removeNonHumanResource(NonHumanResource resource, java.lang.String handle)` Removes (deletes) the specified NonHumanResource from the service's org data
`boolean`	`removeNonHumanSubCategory(java.lang.String id, java.lang.String subcategory, java.lang.String handle)` Removes a subcategory of a NonHumanResource category
`boolean`	`removeNonHumanSubCategoryByName(java.lang.String category, java.lang.String subcategory, java.lang.String handle)` Removes a subcategory of a NonHumanResource category
`java.lang.String`	`removeOrgGroup(OrgGroup group, java.lang.String handle)` Removes (deletes) the specified OrgGroup from the service's org data
`java.lang.String`	`removeParticipant(Participant p, java.lang.String handle)` Removes (deletes) the specified Participant from the service's org data
`java.lang.String`	`removeParticipantFromCapability(Participant p, Capability cap, java.lang.String handle)` Removes (deletes) the specified Participant from the set of Participants holding the specified Capability
`java.lang.String`	`removeParticipantFromPosition(Participant p, Position pos, java.lang.String handle)` Removes (deletes) the specified Participant from the set of Participants occupying the specified Position
`java.lang.String`	`removeParticipantFromRole(Participant p, Role role, java.lang.String handle)` Removes (deletes) the specified Participant from the set of Participants occupying the specified Role
`java.lang.String`	`removePosition(Position pos, java.lang.String handle)` Removes (deletes) the specified Position from the service's org data
`java.lang.String`	`removeRole(Role role, java.lang.String handle)` Removes (deletes) the specified Role from the service's org data
`void`	`setClientURI(java.lang.String uri)`
`java.lang.String`	`setContainingOrgGroup(OrgGroup group, OrgGroup containingGroup, java.lang.String handle)` Sets the containing OrgGroup for an OrgGroup (i.e.
`java.lang.String`	`setContainingPosition(Position pos, Position containingPos, java.lang.String handle)` Sets the containing Position for a Position (i.e.
`java.lang.String`	`setContainingRole(Role role, Role containingRole, java.lang.String handle)` Sets the containing Role for a Role (i.e.
`java.lang.String`	`setParticipantPrivileges(Participant p, java.lang.String handle)` Sets the user privileges for a Participant
`java.lang.String`	`setParticipantPrivileges(Participant p, UserPrivileges privs, java.lang.String handle)` Sets the user privileges for a Participant
`java.lang.String`	`setPositionOrgGroup(Position pos, OrgGroup group, java.lang.String handle)` Sets the containing OrgGroup for a Position
`protected java.lang.String`	`successCheck(java.lang.String xml)`
`boolean`	`successful(java.lang.String result)`
`java.lang.String`	`updateCapability(Capability cap, java.lang.String handle)` Updates the Capability stored in the service's org data with the modified values of the Capability specified
`java.lang.String`	`updateNonHumanCategory(NonHumanCategory category, java.lang.String handle)` Updates the NonHumanCategory stored in the service's org data with the modified values of the NonHumanResource specified
`java.lang.String`	`updateNonHumanResource(NonHumanResource resource, java.lang.String handle)` Updates a new NonHumanResource to the service's org data with the modified values of the NonHumanResource specified
`java.lang.String`	`updateOrgGroup(OrgGroup group, java.lang.String handle)` Updates the OrgGroup stored in the service's org data with the modified values of the OrgGroup specified
`java.lang.String`	`updateParticipant(Participant p, boolean encryptPassword, java.lang.String handle)` Updates the Participant stored in the service's org data with the modified values of the Participant specified
`java.lang.String`	`updateParticipant(Participant p, java.lang.String handle)` Updates the Participant stored in the service's org data with the modified values of the Participant specified
`java.lang.String`	`updatePosition(Position pos, java.lang.String handle)` Updates the Position stored in the service's org data with the modified values of the Position specified
`java.lang.String`	`updateRole(Role role, java.lang.String handle)` Updates the Role stored in the service's org data with the modified values of the Role specified
`java.lang.String`	`validateUserCredentials(java.lang.String userid, java.lang.String password, boolean checkForAdmin, java.lang.String handle)` Checks the user credentials passed against those stored

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - XML_FORMAT
```
public static final java.lang.String XML_FORMAT
```
    See Also:
    
    Constant Field Values
  - JSON_FORMAT
```
public static final java.lang.String JSON_FORMAT
```
    See Also:
    
    Constant Field Values
  - _rgclient
```
protected ResourceGatewayClient _rgclient
```
  - _uri
```
protected java.lang.String _uri
```
  - _marshaller
```
protected ResourceMarshaller _marshaller
```
  - _xnodeParser
```
protected XNodeParser _xnodeParser
```
- Constructor Detail
  - ResourceGatewayClientAdapter
```
public ResourceGatewayClientAdapter()
```
  - ResourceGatewayClientAdapter
```
public ResourceGatewayClientAdapter(java.lang.String uri)
```
- Method Detail
  - setClientURI
```
public void setClientURI(java.lang.String uri)
```
  - getClientURI
```
public java.lang.String getClientURI()
```
  - getClient
```
public ResourceGatewayClient getClient()
```
  - successful
```
public boolean successful(java.lang.String result)
```
  - successCheck
```
protected java.lang.String successCheck(java.lang.String xml)
                                 throws ResourceGatewayException
```
    Throws:
    
    ResourceGatewayException
  - checkConnection
```
public boolean checkConnection(java.lang.String handle)
```
    Checks that the connection to the service is valid
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the connection is valid, false if otherwise
  - connect
```
public java.lang.String connect(java.lang.String userid,
                                java.lang.String password)
```
    Attempts to connect to the service
    
    Parameters:
    
    userid - the userid
    
    password - the corresponding password
    
    Returns:
    
    a sessionhandle if successful, or a failure message if otherwise
  - disconnect
```
public void disconnect(java.lang.String handle)
```
    Disconnects a session from the service
    
    Parameters:
    
    handle - the sessionhandle of the session to disconnect
  - validateUserCredentials
```
public java.lang.String validateUserCredentials(java.lang.String userid,
                                                java.lang.String password,
                                                boolean checkForAdmin,
                                                java.lang.String handle)
                                         throws java.io.IOException,
                                                ResourceGatewayException
```
    Checks the user credentials passed against those stored
    
    Parameters:
    
    userid - the userid of the Participant
    
    password - the associated password
    
    checkForAdmin - when true, also checks that the user has admin privileges
    
    handle - a valid session handle
    
    Returns:
    
    an XML message of success or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there was a problem validating the credentials
  - getAllParticipantNames
```
public java.util.List<java.lang.String> getAllParticipantNames(java.lang.String handle)
                                                        throws java.io.IOException,
                                                               ResourceGatewayException
```
    Gets the full name of each participant
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of participant full names
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the names
  - getAllRoleNames
```
public java.util.List<java.lang.String> getAllRoleNames(java.lang.String handle)
                                                 throws java.io.IOException,
                                                        ResourceGatewayException
```
    Gets the name of each role
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of role names
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the names
  - getAllNonHumanResourceNames
```
public java.util.List<java.lang.String> getAllNonHumanResourceNames(java.lang.String handle)
                                                             throws java.io.IOException,
                                                                    ResourceGatewayException
```
    Gets the name of each NonHumanResource
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of NonHumanResource names
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the names
  - getNonHumanResources
```
public java.util.List<NonHumanResource> getNonHumanResources(java.lang.String handle)
                                                      throws java.io.IOException,
                                                             ResourceGatewayException
```
    Gets a complete list of available NonHumanResource objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of NonHumanResource objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the NonHumanResource
  - getRoles
```
public java.util.List getRoles(java.lang.String handle)
                        throws java.io.IOException,
                               ResourceGatewayException
```
    Gets a complete list of available Role objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Role objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the roles
  - getCapabilities
```
public java.util.List getCapabilities(java.lang.String handle)
                               throws java.io.IOException,
                                      ResourceGatewayException
```
    Gets a complete list of available Capability objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Capability objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the capabilities
  - getPositions
```
public java.util.List getPositions(java.lang.String handle)
                            throws java.io.IOException,
                                   ResourceGatewayException
```
    Gets a complete list of available Position objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Position objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the positions
  - getOrgGroups
```
public java.util.List getOrgGroups(java.lang.String handle)
                            throws java.io.IOException,
                                   ResourceGatewayException
```
    Gets a complete list of available OrgGroup objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of OrgGroup objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the groups
  - getParticipants
```
public java.util.List<Participant> getParticipants(java.lang.String handle)
                                            throws java.io.IOException,
                                                   ResourceGatewayException
```
    Gets a complete list of available Participant objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Participant objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the participants
  - getParticipant
```
public Participant getParticipant(java.lang.String pid,
                                  java.lang.String handle)
                           throws java.io.IOException,
                                  ResourceGatewayException
```
    Gets a particular Participant
    
    Parameters:
    
    pid - the id of the Participant to get
    
    handle - the current session handle
    
    Returns:
    
    a Participant object for the id, or null if not found
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the participant
  - getReferencedParticipantIDs
```
public java.util.Set<java.lang.String> getReferencedParticipantIDs(java.lang.String anyID,
                                                                   java.lang.String handle)
                                                            throws java.io.IOException
```
    Gets a set of participant ids referenced by the id string argument
    
    Parameters:
    
    anyID - the id of a Participant, Role, Capability, Position or OrgGroup
    
    handle - a valid session handle
    
    Returns:
    
    the set of the ids of all participants who are members of the group object referenced; if anyID is the id of a single participant, then only that id is returned in the set
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getConstraints
```
public java.util.List<AbstractSelector> getConstraints(java.lang.String handle)
                                                throws java.io.IOException,
                                                       ResourceGatewayException
```
    Gets a complete list of available Constraint objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Constraint objects (instantiated as GenericConstraint objs)
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the constraints
  - getAllocators
```
public java.util.List<AbstractSelector> getAllocators(java.lang.String handle)
                                               throws java.io.IOException,
                                                      ResourceGatewayException
```
    Gets a complete list of available Allocator objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Allocator objects (instantiated as GenericAllocator objs)
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the allocators
  - getFilters
```
public java.util.List<AbstractSelector> getFilters(java.lang.String handle)
                                            throws java.io.IOException,
                                                   ResourceGatewayException
```
    Gets a complete list of available Filter objects
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of Filter objects (instantiated as GenericFilter objs)
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the filters
  - getCodelets
```
public java.util.List<CodeletInfo> getCodelets(java.lang.String handle)
                                        throws java.io.IOException,
                                               ResourceGatewayException
```
    Gets a complete list of available codelets
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of AbstractCodelet objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the codelets
  - getCodeletMap
```
public java.util.Map<java.lang.String,java.lang.String> getCodeletMap(java.lang.String handle)
                                                               throws java.io.IOException,
                                                                      ResourceGatewayException
```
    Throws:
    
    java.io.IOException
    
    ResourceGatewayException
  - getCodeletParameters
```
public java.util.List<YParameter> getCodeletParameters(java.lang.String codeletName,
                                                       java.lang.String handle)
                                                throws java.io.IOException,
                                                       ResourceGatewayException
```
    Throws:
    
    java.io.IOException
    
    ResourceGatewayException
  - isKnownCapability
```
public boolean isKnownCapability(java.lang.String capabilityID,
                                 java.lang.String handle)
```
    Checks if an id corresponds to a capability id known to the service
    
    Parameters:
    
    capabilityID - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - isKnownNonHumanResource
```
public boolean isKnownNonHumanResource(java.lang.String id,
                                       java.lang.String handle)
```
    Checks if an id corresponds to a NonHumanResource id known to the service
    
    Parameters:
    
    id - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - isKnownRole
```
public boolean isKnownRole(java.lang.String roleID,
                           java.lang.String handle)
```
    Checks if an id corresponds to a role id known to the service
    
    Parameters:
    
    roleID - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - isKnownParticipant
```
public boolean isKnownParticipant(java.lang.String participantID,
                                  java.lang.String handle)
```
    Checks if an id corresponds to a participant id known to the service
    
    Parameters:
    
    participantID - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - isKnownPosition
```
public boolean isKnownPosition(java.lang.String positionID,
                               java.lang.String handle)
```
    Checks if an id corresponds to a position id known to the service
    
    Parameters:
    
    positionID - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - isKnownOrgGroup
```
public boolean isKnownOrgGroup(java.lang.String groupID,
                               java.lang.String handle)
```
    Checks if an id corresponds to a OrgGroup id known to the service
    
    Parameters:
    
    groupID - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - isKnownNonHumanCategory
```
public boolean isKnownNonHumanCategory(java.lang.String id,
                                       java.lang.String handle)
```
    Checks if an id corresponds to a NonHumanCategory id known to the service
    
    Parameters:
    
    id - the id to check
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the id is known (valid), false if otherwise
  - getActiveParticipants
```
public java.util.Set<Participant> getActiveParticipants(java.lang.String handle)
                                                 throws java.io.IOException,
                                                        ResourceGatewayException
```
    Gets the set of Participants that are currently logged on
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    the Set of currently logged on Participants
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the participants
  - getParticipantRoles
```
public java.util.List getParticipantRoles(java.lang.String pid,
                                          java.lang.String handle)
                                   throws java.io.IOException,
                                          ResourceGatewayException
```
    Gets a list of all roles 'occupied' by the specified participant
    
    Parameters:
    
    pid - the id of the Participant of interest
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of (Role) objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the roles
  - getParticipantCapabilities
```
public java.util.List getParticipantCapabilities(java.lang.String pid,
                                                 java.lang.String handle)
                                          throws java.io.IOException,
                                                 ResourceGatewayException
```
    Gets a list of all capabilities held by the specified participant
    
    Parameters:
    
    pid - the id of the Participant of interest
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of (Capability) objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the capabilities
  - getParticipantPositions
```
public java.util.List getParticipantPositions(java.lang.String pid,
                                              java.lang.String handle)
                                       throws java.io.IOException,
                                              ResourceGatewayException
```
    Gets a list of all positions held by the specified participant
    
    Parameters:
    
    pid - the id of the Participant of interest
    
    handle - the current sessionhandle
    
    Returns:
    
    a List of (Position) objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the positions
  - getParticipantsWithRole
```
public java.util.Set<Participant> getParticipantsWithRole(java.lang.String roleName,
                                                          java.lang.String handle)
                                                   throws java.io.IOException,
                                                          ResourceGatewayException
```
    Gets the set of Participants that 'occupy' the named role
    
    Parameters:
    
    roleName - the name of the role in question (not the id)
    
    handle - the current sessionhandle
    
    Returns:
    
    a Set of Participant objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the participants
  - getParticipantsWithPosition
```
public java.util.Set<Participant> getParticipantsWithPosition(java.lang.String positionName,
                                                              java.lang.String handle)
                                                       throws java.io.IOException,
                                                              ResourceGatewayException
```
    Gets the set of Participants that 'occupy' the named position
    
    Parameters:
    
    positionName - the name of the position in question (not the id)
    
    handle - the current sessionhandle
    
    Returns:
    
    a Set of Participant objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the participants
  - getParticipantsWithCapability
```
public java.util.Set<Participant> getParticipantsWithCapability(java.lang.String capabilityName,
                                                                java.lang.String handle)
                                                         throws java.io.IOException,
                                                                ResourceGatewayException
```
    Gets the set of Participants that hold the named capability
    
    Parameters:
    
    capabilityName - the name of the capability in question (not the id)
    
    handle - the current sessionhandle
    
    Returns:
    
    a Set of Participant objects
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the participants
  - getParticipantFromUserID
```
public Participant getParticipantFromUserID(java.lang.String userID,
                                            java.lang.String handle)
                                     throws java.io.IOException,
                                            ResourceGatewayException
```
    Gets the Participant with the specified user id
    
    Parameters:
    
    userID - the userid to match to a Participant
    
    handle - a valid session handle
    
    Returns:
    
    the matching Participant
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Participant
  - getNonHumanResource
```
public NonHumanResource getNonHumanResource(java.lang.String id,
                                            java.lang.String handle)
                                     throws java.io.IOException,
                                            ResourceGatewayException
```
    Gets the NonHumanResource with the specified id
    
    Parameters:
    
    id - the id of the NonHumanResource to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching NonHumanResource
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the NonHumanResource
  - getNonHumanResourceByName
```
public NonHumanResource getNonHumanResourceByName(java.lang.String name,
                                                  java.lang.String handle)
                                           throws java.io.IOException,
                                                  ResourceGatewayException
```
    Gets the NonHumanResource with the specified name
    
    Parameters:
    
    name - the id of the NonHumanResource to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching NonHumanResource
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the NonHumanResource
  - getRole
```
public Role getRole(java.lang.String id,
                    java.lang.String handle)
             throws java.io.IOException,
                    ResourceGatewayException
```
    Gets the Role with the specified id
    
    Parameters:
    
    id - the id of the Role to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching Role
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Role
  - getRoleByName
```
public Role getRoleByName(java.lang.String name,
                          java.lang.String handle)
                   throws java.io.IOException,
                          ResourceGatewayException
```
    Gets the Role with the specified name
    
    Parameters:
    
    name - the id of the Role to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching Role
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Role
  - getCapability
```
public Capability getCapability(java.lang.String id,
                                java.lang.String handle)
                         throws java.io.IOException,
                                ResourceGatewayException
```
    Gets the Capability with the specified id
    
    Parameters:
    
    id - the id of the Capability to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching Capability
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Capability
  - getCapabilityByName
```
public Capability getCapabilityByName(java.lang.String name,
                                      java.lang.String handle)
                               throws java.io.IOException,
                                      ResourceGatewayException
```
    Gets the Capability with the specified name
    
    Parameters:
    
    name - the id of the Capability to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching Capability
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Capability
  - getPosition
```
public Position getPosition(java.lang.String id,
                            java.lang.String handle)
                     throws java.io.IOException,
                            ResourceGatewayException
```
    Gets the Position with the specified id
    
    Parameters:
    
    id - the id of the Position to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching Position
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Position
  - getPositionByName
```
public Position getPositionByName(java.lang.String name,
                                  java.lang.String handle)
                           throws java.io.IOException,
                                  ResourceGatewayException
```
    Gets the Position with the specified name
    
    Parameters:
    
    name - the id of the Position to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching Position
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Position
  - getOrgGroup
```
public OrgGroup getOrgGroup(java.lang.String id,
                            java.lang.String handle)
                     throws java.io.IOException,
                            ResourceGatewayException
```
    Gets the OrgGroup with the specified id
    
    Parameters:
    
    id - the id of the OrgGroup to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching OrgGroup
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the OrgGroup
  - getOrgGroupByName
```
public OrgGroup getOrgGroupByName(java.lang.String name,
                                  java.lang.String handle)
                           throws java.io.IOException,
                                  ResourceGatewayException
```
    Gets the OrgGroup with the specified name
    
    Parameters:
    
    name - the id of the OrgGroup to get
    
    handle - a valid session handle
    
    Returns:
    
    the matching OrgGroup
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the OrgGroup
  - getParticipantIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getParticipantIdentifiers(java.lang.String handle)
                                                                           throws java.io.IOException,
                                                                                  ResourceGatewayException
```
    Gets the id and full name of every Participant
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a Map of Participant id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Participants
  - getParticipantIdentifiersToJSON
```
public java.lang.String getParticipantIdentifiersToJSON(java.lang.String handle)
                                                 throws java.io.IOException,
                                                        ResourceGatewayException
```
    Gets the id and full name of every Participant in JSON format
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of Participant id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Participants
  - getParticipantIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getParticipantIdentifiers(ResourceDataSet.Identifier identifier,
                                                                                  java.lang.String handle)
                                                                           throws java.io.IOException,
                                                                                  ResourceGatewayException
```
    Gets the id and chosen name value of every Participant
    
    Parameters:
    
    identifier - a valid ResourceDataSet Identifier value
    
    handle - a valid session handle
    
    Returns:
    
    a Map of Participant id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Participants
  - getParticipantIdentifiersToJSON
```
public java.lang.String getParticipantIdentifiersToJSON(ResourceDataSet.Identifier identifier,
                                                        java.lang.String handle)
                                                 throws java.io.IOException,
                                                        ResourceGatewayException
```
    Gets the id and chosen name value of every Participant in JSON format
    
    Parameters:
    
    identifier - a valid ResourceDataSet Identifier value
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of Participant id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Participants
  - getNonHumanResourceIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getNonHumanResourceIdentifiers(java.lang.String handle)
                                                                                throws java.io.IOException,
                                                                                       ResourceGatewayException
```
    Gets the id and name of every NonHumanResource
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a Map of NonHumanResource id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the NonHumanResources
  - getNonHumanResourceIdentifiersToJSON
```
public java.lang.String getNonHumanResourceIdentifiersToJSON(java.lang.String handle)
                                                      throws java.io.IOException,
                                                             ResourceGatewayException
```
    Gets the id and name of every NonHumanResource in JSON format
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of NonHumanResource id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the NonHumanResources
  - getRoleIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getRoleIdentifiers(java.lang.String handle)
                                                                    throws java.io.IOException,
                                                                           ResourceGatewayException
```
    Gets the id and name of every Role
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a Map of Role id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Roles
  - getRoleIdentifiersToJSON
```
public java.lang.String getRoleIdentifiersToJSON(java.lang.String handle)
                                          throws java.io.IOException,
                                                 ResourceGatewayException
```
    Gets the id and name of every Role in JSON format
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of Role id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Roles
  - getPositionIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getPositionIdentifiers(java.lang.String handle)
                                                                        throws java.io.IOException,
                                                                               ResourceGatewayException
```
    Gets the id and name of every Position
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a Map of Position id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Positions
  - getPositionIdentifiersToJSON
```
public java.lang.String getPositionIdentifiersToJSON(java.lang.String handle)
                                              throws java.io.IOException,
                                                     ResourceGatewayException
```
    Gets the id and name of every Position in JSON format
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of Position id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Positions
  - getCapabilityIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getCapabilityIdentifiers(java.lang.String handle)
                                                                          throws java.io.IOException,
                                                                                 ResourceGatewayException
```
    Gets the id and name of every Capability
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a Map of Capability id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Capabilities
  - getCapabilityIdentifiersToJSON
```
public java.lang.String getCapabilityIdentifiersToJSON(java.lang.String handle)
                                                throws java.io.IOException,
                                                       ResourceGatewayException
```
    Gets the id and name of every Capability in JSON format
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of Capability id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the Capabilities
  - getOrgGroupIdentifiers
```
public java.util.Map<java.lang.String,java.lang.String> getOrgGroupIdentifiers(java.lang.String handle)
                                                                        throws java.io.IOException,
                                                                               ResourceGatewayException
```
    Gets the id and name of every OrgGroup
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a Map of OrgGroup id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the OrgGroups
  - getOrgGroupIdentifiersToJSON
```
public java.lang.String getOrgGroupIdentifiersToJSON(java.lang.String handle)
                                              throws java.io.IOException,
                                                     ResourceGatewayException
```
    Gets the id and name of every OrgGroup in JSON format
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    a JSON String of OrgGroup id/name pairs
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the OrgGroups
  - getUserPrivileges
```
public UserPrivileges getUserPrivileges(java.lang.String id,
                                        java.lang.String handle)
                                 throws java.io.IOException,
                                        ResourceGatewayException
```
    Gets the UserPrivileges of the Participant with the specified id
    
    Parameters:
    
    id - the id of the Participant to get the UserPrivileges for
    
    handle - a valid session handle
    
    Returns:
    
    the matching UserPrivileges
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there is some problem getting the UserPrivileges
  - addParticipant
```
public java.lang.String addParticipant(Participant p,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Adds a new participant to the service's org data
    
    Parameters:
    
    p - the Participant
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added Participant, or an error message if there was a problem (note: the returned id should be subsequently added to the Participant object using p.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addParticipant
```
public java.lang.String addParticipant(Participant p,
                                       boolean encryptPassword,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Adds a new participant to the service's org data
    
    Parameters:
    
    p - the Participant
    
    encryptPassword - if true, will encrypt the current password within 'p' before storing it on the server side (recommended for plain text passwords)
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added Participant, or an error message if there was a problem (note: the returned id should be subsequently added to the Participant object using p.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addNonHumanResource
```
public java.lang.String addNonHumanResource(NonHumanResource resource,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Adds a new NonHumanResource to the service's org data
    
    Parameters:
    
    resource - the NonHumanResource
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added NonHumanResource, or an error message if there was a problem (note: the returned id should be subsequently added to the NonHumanResource object using resource.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addCapability
```
public java.lang.String addCapability(Capability cap,
                                      java.lang.String handle)
                               throws java.io.IOException
```
    Adds a new capability to the service's org data
    
    Parameters:
    
    cap - the Capability
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added Capability, or an error message if there was a problem (note: the returned id should be subsequently added to the Capability object using cap.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addRole
```
public java.lang.String addRole(Role role,
                                java.lang.String handle)
                         throws java.io.IOException
```
    Adds a new role to the service's org data
    
    Parameters:
    
    role - the Role
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added Role, or an error message if there was a problem (note: the returned id should be subsequently added to the Role object using role.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addPosition
```
public java.lang.String addPosition(Position pos,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Adds a new position to the service's org data
    
    Parameters:
    
    pos - the Position
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added Position, or an error message if there was a problem (note: the returned id should be subsequently added to the Position object using pos.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addOrgGroup
```
public java.lang.String addOrgGroup(OrgGroup group,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Adds a new org group to the service's org data
    
    Parameters:
    
    group - the OrgGroup
    
    handle - the current sessionhandle
    
    Returns:
    
    the id of the newly added OrgGroup, or an error message if there was a problem (note: the returned id should be subsequently added to the OrgGroup object using group.setID() )
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addParticipantToRole
```
public java.lang.String addParticipantToRole(Participant p,
                                             Role role,
                                             java.lang.String handle)
                                      throws java.io.IOException
```
    Adds the specified Participant to the specified Role
    
    Parameters:
    
    p - the Participant
    
    role - the Role to add the Particpant to
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addParticipantToCapability
```
public java.lang.String addParticipantToCapability(Participant p,
                                                   Capability cap,
                                                   java.lang.String handle)
                                            throws java.io.IOException
```
    Adds the specified Participant to the specified Capability
    
    Parameters:
    
    p - the Participant
    
    cap - the Capability to add the Particpant to
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - addParticipantToPosition
```
public java.lang.String addParticipantToPosition(Participant p,
                                                 Position pos,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Adds the specified Participant to the specified Position
    
    Parameters:
    
    p - the Participant
    
    pos - the Position to add the Particpant to
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateParticipant
```
public java.lang.String updateParticipant(Participant p,
                                          boolean encryptPassword,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Updates the Participant stored in the service's org data with the modified values of the Participant specified
    
    Parameters:
    
    p - the Participant
    
    encryptPassword - if true, will encrypt the current password within 'p' before storing it on the server side (recommended for plain text passwords)
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateParticipant
```
public java.lang.String updateParticipant(Participant p,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Updates the Participant stored in the service's org data with the modified values of the Participant specified
    
    Parameters:
    
    p - the Participant
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateNonHumanResource
```
public java.lang.String updateNonHumanResource(NonHumanResource resource,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Updates a new NonHumanResource to the service's org data with the modified values of the NonHumanResource specified
    
    Parameters:
    
    resource - the NonHumanResource
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateCapability
```
public java.lang.String updateCapability(Capability cap,
                                         java.lang.String handle)
                                  throws java.io.IOException
```
    Updates the Capability stored in the service's org data with the modified values of the Capability specified
    
    Parameters:
    
    cap - the Capability
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateRole
```
public java.lang.String updateRole(Role role,
                                   java.lang.String handle)
                            throws java.io.IOException
```
    Updates the Role stored in the service's org data with the modified values of the Role specified
    
    Parameters:
    
    role - the Role
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updatePosition
```
public java.lang.String updatePosition(Position pos,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Updates the Position stored in the service's org data with the modified values of the Position specified
    
    Parameters:
    
    pos - the Position
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateOrgGroup
```
public java.lang.String updateOrgGroup(OrgGroup group,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Updates the OrgGroup stored in the service's org data with the modified values of the OrgGroup specified
    
    Parameters:
    
    group - the OrgGroup
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - updateNonHumanCategory
```
public java.lang.String updateNonHumanCategory(NonHumanCategory category,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Updates the NonHumanCategory stored in the service's org data with the modified values of the NonHumanResource specified
    
    Parameters:
    
    category - the NonHumanResource
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeParticipant
```
public java.lang.String removeParticipant(Participant p,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Removes (deletes) the specified Participant from the service's org data
    
    Parameters:
    
    p - the Participant
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeNonHumanResource
```
public java.lang.String removeNonHumanResource(NonHumanResource resource,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Removes (deletes) the specified NonHumanResource from the service's org data
    
    Parameters:
    
    resource - the NonHumanResource
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeCapability
```
public java.lang.String removeCapability(Capability cap,
                                         java.lang.String handle)
                                  throws java.io.IOException
```
    Removes (deletes) the specified Capability from the service's org data
    
    Parameters:
    
    cap - the Capability
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeRole
```
public java.lang.String removeRole(Role role,
                                   java.lang.String handle)
                            throws java.io.IOException
```
    Removes (deletes) the specified Role from the service's org data
    
    Parameters:
    
    role - the Role
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removePosition
```
public java.lang.String removePosition(Position pos,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Removes (deletes) the specified Position from the service's org data
    
    Parameters:
    
    pos - the Position
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeOrgGroup
```
public java.lang.String removeOrgGroup(OrgGroup group,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Removes (deletes) the specified OrgGroup from the service's org data
    
    Parameters:
    
    group - the OrgGroup
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeParticipantFromRole
```
public java.lang.String removeParticipantFromRole(Participant p,
                                                  Role role,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Removes (deletes) the specified Participant from the set of Participants occupying the specified Role
    
    Parameters:
    
    p - the Participant
    
    role - the Role to remove the specified Participant from
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeParticipantFromCapability
```
public java.lang.String removeParticipantFromCapability(Participant p,
                                                        Capability cap,
                                                        java.lang.String handle)
                                                 throws java.io.IOException
```
    Removes (deletes) the specified Participant from the set of Participants holding the specified Capability
    
    Parameters:
    
    p - the Participant
    
    cap - the Capability to remove the specified Participant from
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - removeParticipantFromPosition
```
public java.lang.String removeParticipantFromPosition(Participant p,
                                                      Position pos,
                                                      java.lang.String handle)
                                               throws java.io.IOException
```
    Removes (deletes) the specified Participant from the set of Participants occupying the specified Position
    
    Parameters:
    
    p - the Participant
    
    pos - the Position to remove the specified Participant from
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - setContainingRole
```
public java.lang.String setContainingRole(Role role,
                                          Role containingRole,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Sets the containing Role for a Role (i.e. the 'parent' Role the Role 'belongs to')
    
    Parameters:
    
    role - the Role
    
    containingRole - the containing or parent Role that encapsulates role
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - setContainingOrgGroup
```
public java.lang.String setContainingOrgGroup(OrgGroup group,
                                              OrgGroup containingGroup,
                                              java.lang.String handle)
                                       throws java.io.IOException
```
    Sets the containing OrgGroup for an OrgGroup (i.e. the 'parent' OrgGroup the OrgGroup 'belongs to')
    
    Parameters:
    
    group - the OrgGroup
    
    containingGroup - the containing or parent OrgGroup that encapsulates group
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - setContainingPosition
```
public java.lang.String setContainingPosition(Position pos,
                                              Position containingPos,
                                              java.lang.String handle)
                                       throws java.io.IOException
```
    Sets the containing Position for a Position (i.e. the 'parent' Position the Position 'reports to')
    
    Parameters:
    
    pos - the Position
    
    containingPos - the containing or parent Position that encapsulates pos
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - setPositionOrgGroup
```
public java.lang.String setPositionOrgGroup(Position pos,
                                            OrgGroup group,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Sets the containing OrgGroup for a Position
    
    Parameters:
    
    pos - the Position
    
    group - the containing OrgGroup
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - setParticipantPrivileges
```
public java.lang.String setParticipantPrivileges(Participant p,
                                                 UserPrivileges privs,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Sets the user privileges for a Participant
    
    Parameters:
    
    p - the Participant
    
    privs - the UserPrivileges object
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - setParticipantPrivileges
```
public java.lang.String setParticipantPrivileges(Participant p,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Sets the user privileges for a Participant
    
    Parameters:
    
    p - the Participant (note: the privilege values used are the ones currently within the Participant object specified)
    
    handle - the current sessionhandle
    
    Returns:
    
    a message indicating success, or describing a problem encountered
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
  - getNonHumanCategory
```
public NonHumanCategory getNonHumanCategory(java.lang.String id,
                                            java.lang.String handle)
                                     throws java.io.IOException,
                                            ResourceGatewayException
```
    Gets the NonHumanCategory with the specified id
    
    Parameters:
    
    id - a valid NonHumanCategory identifier
    
    handle - a valid session handle
    
    Returns:
    
    the NonHumanCategory object matching the id specified
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there was a problem getting the NonHumanCategory
  - getNonHumanCategoryByName
```
public NonHumanCategory getNonHumanCategoryByName(java.lang.String name,
                                                  java.lang.String handle)
                                           throws java.io.IOException,
                                                  ResourceGatewayException
```
    Gets the NonHumanCategory with the specified name
    
    Parameters:
    
    name - a valid NonHumanCategory name
    
    handle - a valid session handle
    
    Returns:
    
    the NonHumanCategory object matching the name specified
    
    Throws:
    
    java.io.IOException - if the service can't be reached
    
    ResourceGatewayException - if there was a problem getting the NonHumanCategory
  - getNonHumanCategories
```
public java.util.List<NonHumanCategory> getNonHumanCategories(java.lang.String handle)
                                                       throws java.io.IOException,
                                                              ResourceGatewayException
```
    Gets the list of all NonHumanCategory objects known to the Resource Service
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a list of categories
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - getNonHumanCategoriesToJSON
```
public java.lang.String getNonHumanCategoriesToJSON(java.lang.String handle)
                                             throws java.io.IOException,
                                                    ResourceGatewayException
```
    Gets the list of all NonHumanResource category names in JSON format
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a JSON String of paired category names
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - getNonHumanSubCategories
```
public java.util.List<java.lang.String> getNonHumanSubCategories(java.lang.String id,
                                                                 java.lang.String handle)
                                                          throws java.io.IOException,
                                                                 ResourceGatewayException
```
    Gets the list of all the subcategory names of a NonHumanResource category
    
    Parameters:
    
    id - the category id to get the subcategories for
    
    handle - the current sessionhandle
    
    Returns:
    
    a list of category name strings
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - getNonHumanSubCategoriesByName
```
public java.util.List<java.lang.String> getNonHumanSubCategoriesByName(java.lang.String category,
                                                                       java.lang.String handle)
                                                                throws java.io.IOException,
                                                                       ResourceGatewayException
```
    Gets the list of all the subcategory names of a NonHumanResource category
    
    Parameters:
    
    category - the category name to get the subcategories for
    
    handle - the current sessionhandle
    
    Returns:
    
    a list of category name strings
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - getNonHumanSubCategoriesToJSON
```
public java.lang.String getNonHumanSubCategoriesToJSON(java.lang.String id,
                                                       java.lang.String handle)
                                                throws java.io.IOException,
                                                       ResourceGatewayException
```
    Gets the list of all the subcategory names of a NonHumanResource category in JSON format
    
    Parameters:
    
    id - the category id to get the subcategories for
    
    handle - the current sessionhandle
    
    Returns:
    
    a JSON String of category name pairs
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - getNonHumanSubCategoriesToJSONByName
```
public java.lang.String getNonHumanSubCategoriesToJSONByName(java.lang.String category,
                                                             java.lang.String handle)
                                                      throws java.io.IOException,
                                                             ResourceGatewayException
```
    Gets the list of all the subcategory names of a NonHumanResource category in JSON format
    
    Parameters:
    
    category - the category name to get the subcategories for
    
    handle - the current sessionhandle
    
    Returns:
    
    a JSON String of category name pairs
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - getNonHumanCategorySet
```
public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getNonHumanCategorySet(java.lang.String handle)
                                                                                       throws java.io.IOException,
                                                                                              ResourceGatewayException
```
    Gets the list of all NonHumanResource category names and the subcategories of each
    
    Parameters:
    
    handle - the current sessionhandle
    
    Returns:
    
    a map of category names to a set of subcategory name strings
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem getting the list
  - addNonHumanCategory
```
public java.lang.String addNonHumanCategory(java.lang.String category,
                                            java.lang.String handle)
                                     throws java.io.IOException,
                                            ResourceGatewayException
```
    Adds a new NonHumanResource category
    
    Parameters:
    
    category - the category to add
    
    handle - the current sessionhandle
    
    Returns:
    
    a unique id for the category
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem adding the category
  - addNonHumanSubCategoryByName
```
public boolean addNonHumanSubCategoryByName(java.lang.String category,
                                            java.lang.String subcategory,
                                            java.lang.String handle)
                                     throws java.io.IOException,
                                            ResourceGatewayException
```
    Adds a new NonHumanResource category
    
    Parameters:
    
    category - the category name to add the subcategory to
    
    subcategory - the subcategory to add
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the add was successful
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem adding the subcategory
  - addNonHumanSubCategory
```
public boolean addNonHumanSubCategory(java.lang.String id,
                                      java.lang.String subcategory,
                                      java.lang.String handle)
                               throws java.io.IOException,
                                      ResourceGatewayException
```
    Adds a new NonHumanResource category
    
    Parameters:
    
    id - the identifier of the category to add the subcategory to
    
    subcategory - the subcategory to add
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the add was successful
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem adding the subcategory
  - removeNonHumanCategory
```
public boolean removeNonHumanCategory(java.lang.String id,
                                      java.lang.String handle)
                               throws java.io.IOException,
                                      ResourceGatewayException
```
    Removes a category of the list of NonHumanResource categories
    
    Parameters:
    
    id - the identifier of the category to remove; all of the category's subcategories will also be removed
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the removal was successful
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem removing the category
  - removeNonHumanCategoryByName
```
public boolean removeNonHumanCategoryByName(java.lang.String name,
                                            java.lang.String handle)
                                     throws java.io.IOException,
                                            ResourceGatewayException
```
    Removes a category of the list of NonHumanResource categories
    
    Parameters:
    
    name - the name of the category to remove; all of the category's subcategories will also be removed
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the removal was successful
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem removing the category
  - removeNonHumanSubCategoryByName
```
public boolean removeNonHumanSubCategoryByName(java.lang.String category,
                                               java.lang.String subcategory,
                                               java.lang.String handle)
                                        throws java.io.IOException,
                                               ResourceGatewayException
```
    Removes a subcategory of a NonHumanResource category
    
    Parameters:
    
    category - the name of the category to remove the subcategory from
    
    subcategory - the subcategory name to remove
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the removal was successful
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem removing the subcategory
  - removeNonHumanSubCategory
```
public boolean removeNonHumanSubCategory(java.lang.String id,
                                         java.lang.String subcategory,
                                         java.lang.String handle)
                                  throws java.io.IOException,
                                         ResourceGatewayException
```
    Removes a subcategory of a NonHumanResource category
    
    Parameters:
    
    id - the identifier of the category to remove the subcategory from
    
    subcategory - the subcategory name to remove
    
    handle - the current sessionhandle
    
    Returns:
    
    true if the removal was successful
    
    Throws:
    
    java.io.IOException - if there was a problem connecting to the resource service
    
    ResourceGatewayException - if there was a problem removing the subcategory

Class ResourceGatewayClientAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_FORMAT

JSON_FORMAT

_rgclient

_uri

_marshaller

_xnodeParser

Constructor Detail

ResourceGatewayClientAdapter

ResourceGatewayClientAdapter

Method Detail

setClientURI

getClientURI

getClient

successful

successCheck

checkConnection

connect

disconnect

validateUserCredentials

getAllParticipantNames

getAllRoleNames

getAllNonHumanResourceNames

getNonHumanResources

getRoles

getCapabilities

getPositions

getOrgGroups

getParticipants

getParticipant

getReferencedParticipantIDs

getConstraints

getAllocators

getFilters

getCodelets

getCodeletMap

getCodeletParameters

isKnownCapability

isKnownNonHumanResource

isKnownRole

isKnownParticipant

isKnownPosition

isKnownOrgGroup

isKnownNonHumanCategory

getActiveParticipants

getParticipantRoles

getParticipantCapabilities

getParticipantPositions

getParticipantsWithRole

getParticipantsWithPosition

getParticipantsWithCapability

getParticipantFromUserID

getNonHumanResource

getNonHumanResourceByName

getRole

getRoleByName

getCapability

getCapabilityByName

getPosition

getPositionByName

getOrgGroup

getOrgGroupByName

getParticipantIdentifiers

getParticipantIdentifiersToJSON

getParticipantIdentifiers

getParticipantIdentifiersToJSON

getNonHumanResourceIdentifiers

getNonHumanResourceIdentifiersToJSON

getRoleIdentifiers

getRoleIdentifiersToJSON

getPositionIdentifiers

getPositionIdentifiersToJSON

getCapabilityIdentifiers

getCapabilityIdentifiersToJSON

getOrgGroupIdentifiers