ResourceGatewayClient (YAWL Version 4.3)

java.lang.Object
- org.yawlfoundation.yawl.engine.interfce.Interface_Client
- - org.yawlfoundation.yawl.resourcing.rsInterface.ResourceGatewayClient

```
public class ResourceGatewayClient
extends Interface_Client
```
An API to be used by clients for retrieving organisational model data from the Resource Service.

Author:

Michael Adams 14/08/2007

Constructor Summary

Constructors
Constructor and Description

ResourceGatewayClient()
empty constructor

ResourceGatewayClient(java.lang.String uri)
constructor

Constructors
Constructor and Description
`ResourceGatewayClient()` empty constructor
`ResourceGatewayClient(java.lang.String uri)` constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`addCapability(java.lang.String name, java.lang.String description, java.lang.String notes, java.lang.String handle)` Adds a new Capability to the Resource Service's org data
`java.lang.String`	`addNonHumanCategory(java.lang.String category, java.lang.String handle)` Adds a new category to the set of NonHumanResource categories
`java.lang.String`	`addNonHumanResource(java.lang.String name, java.lang.String category, java.lang.String subcategory, java.lang.String description, java.lang.String notes, java.lang.String handle)` Adds a new NonHumanResource to the Resource Service's org data
`java.lang.String`	`addNonHumanSubCategory(java.lang.String id, java.lang.String subcategory, java.lang.String handle)` Adds a new subcategory to the specified NonHumanResource category
`java.lang.String`	`addNonHumanSubCategoryByName(java.lang.String category, java.lang.String subcategory, java.lang.String handle)` Adds a new subcategory to the specified NonHumanResource category.
`java.lang.String`	`addOrgGroup(java.lang.String name, java.lang.String groupType, java.lang.String description, java.lang.String notes, java.lang.String containingGroupID, java.lang.String handle)` Adds a new OrgGroup to the Resource Service's org data
`java.lang.String`	`addParticipant(java.lang.String userid, java.lang.String password, boolean encrypt, java.lang.String lastname, java.lang.String firstname, boolean admin, java.lang.String description, java.lang.String notes, java.lang.String handle)` Adds a new Participant to the Resource Service's org data
`java.lang.String`	`addParticipantToCapability(java.lang.String participantID, java.lang.String capabilityID, java.lang.String handle)` Adds a Participant to the set of Participants holding a Capability
`java.lang.String`	`addParticipantToPosition(java.lang.String participantID, java.lang.String positionID, java.lang.String handle)` Adds a Participant to the set of Participants holding a Position
`java.lang.String`	`addParticipantToRole(java.lang.String participantID, java.lang.String roleID, java.lang.String handle)` Adds a Participant to the set of Participants occupying a Role
`java.lang.String`	`addPosition(java.lang.String name, java.lang.String positionID, java.lang.String description, java.lang.String notes, java.lang.String orgGroupID, java.lang.String containingPositionID, java.lang.String handle)` Adds a new Position to the Resource Service's org data
`java.lang.String`	`addRole(java.lang.String name, java.lang.String description, java.lang.String notes, java.lang.String containingRoleID, java.lang.String handle)` Adds a new Role to the Resource Service's org data
`java.lang.String`	`checkConnection(java.lang.String handle)` Check that a session handle is active
`java.lang.String`	`connect(java.lang.String userID, java.lang.String password)` Connects an external entity to the resource service
`void`	`disconnect(java.lang.String handle)` Disconnects an external entity from the resource service
`java.lang.String`	`getActiveParticipants(java.lang.String handle)` Gets an XML list of the Participants that are currently logged on to the service
`java.lang.String`	`getAllNonHumanResourceNames(java.lang.String handle)` Gets an XML list of the name of each NonHumanResource known to the service
`java.lang.String`	`getAllocators(java.lang.String handle)` Gets an XML list of all Resource Allocators known to the service
`java.lang.String`	`getAllParticipantNames(java.lang.String handle)` Gets an XML list of the full name of each Participant known to the service
`java.lang.String`	`getAllRoleNames(java.lang.String handle)` Gets an XML list of the name of each Role known to the service
`java.lang.String`	`getAllSelectors(java.lang.String handle)` Gets a concatenated XML list of all Resource Selectors (i.e.
`java.lang.String`	`getCapabilities(java.lang.String handle)` Gets an XML list of all Capabilities known to the service
`java.lang.String`	`getCapability(java.lang.String id, java.lang.String handle)` Gets the Capability with the specified id
`java.lang.String`	`getCapabilityByName(java.lang.String name, java.lang.String handle)` Gets the Capability with the specified name
`java.lang.String`	`getCapabilityIdentifiers(java.lang.String handle)` Gets the id and name of every Capability
`java.lang.String`	`getCapabilityIdentifiers(java.lang.String format, java.lang.String handle)` Gets the id and name of every Capability
`java.lang.String`	`getCodeletParameters(java.lang.String codeletName, java.lang.String handle)` Gets an XML list of the required parameters for the specified codelet
`java.lang.String`	`getCodelets(java.lang.String handle)` Gets an XML list of the Codelets known to the service
`java.lang.String`	`getConstraints(java.lang.String handle)` Gets an XML list of all Resource Constraints known to the service
`java.lang.String`	`getFilters(java.lang.String handle)` Gets an XML list of all Resource Filters known to the service
`java.lang.String`	`getNonHumanCategories(java.lang.String handle)` Gets all the NonHumanResource categories known to the service
`java.lang.String`	`getNonHumanCategories(java.lang.String format, java.lang.String handle)` Gets all the NonHumanResource categories known to the service
`java.lang.String`	`getNonHumanCategory(java.lang.String id, java.lang.String handle)` Gets the NonHumanCategory with the specified id
`java.lang.String`	`getNonHumanCategoryByName(java.lang.String name, java.lang.String handle)` Gets the NonHumanCategory with the specified name
`java.lang.String`	`getNonHumanCategorySet(java.lang.String handle)` Gets all the NonHumanResource categories known to the service, together with each of their subcategories
`java.lang.String`	`getNonHumanResource(java.lang.String id, java.lang.String handle)` Gets a specific NonHumanResource
`java.lang.String`	`getNonHumanResourceByName(java.lang.String name, java.lang.String handle)` Gets the NonHumanResource with the specified name
`java.lang.String`	`getNonHumanResourceIdentifiers(java.lang.String handle)` Gets the id and name of every NonHumanResource
`java.lang.String`	`getNonHumanResourceIdentifiers(java.lang.String format, java.lang.String handle)` Gets the id and name of every NonHumanResource
`java.lang.String`	`getNonHumanResources(java.lang.String handle)` Gets an XML list of all NonHumanResources known to the service
`java.lang.String`	`getNonHumanSubCategories(java.lang.String id, java.lang.String handle)` Gets all the NonHumanResource sub-categories for the specified category identifier
`java.lang.String`	`getNonHumanSubCategories(java.lang.String id, java.lang.String format, java.lang.String handle)` Gets all the NonHumanResource sub-categories for the specified category identifier
`java.lang.String`	`getNonHumanSubCategoriesByName(java.lang.String category, java.lang.String handle)` Gets all the NonHumanResource sub-categories for the specified category name
`java.lang.String`	`getNonHumanSubCategoriesByName(java.lang.String category, java.lang.String format, java.lang.String handle)` Gets all the NonHumanResource sub-categories for the specified category name
`java.lang.String`	`getOrgGroup(java.lang.String id, java.lang.String handle)` Gets the OrgGroup with the specified id
`java.lang.String`	`getOrgGroupByName(java.lang.String name, java.lang.String handle)` Gets the OrgGroup with the specified name
`java.lang.String`	`getOrgGroupIdentifiers(java.lang.String handle)` Gets the id and name of every OrgGroup
`java.lang.String`	`getOrgGroupIdentifiers(java.lang.String format, java.lang.String handle)` Gets the id and name of every OrgGroup
`java.lang.String`	`getOrgGroups(java.lang.String handle)` Gets an XML list of all OrgGroups known to the service
`java.lang.String`	`getParticipant(java.lang.String id, java.lang.String handle)` Gets a specific Participant
`java.lang.String`	`getParticipantCapabilities(java.lang.String id, java.lang.String handle)` Gets all the Capabilities held by the specified Participant
`java.lang.String`	`getParticipantFromUserID(java.lang.String userID, java.lang.String handle)` Gets the participant with the specified user id
`java.lang.String`	`getParticipantIdentifiers(int id, java.lang.String handle)` Gets the id and chosen identifier of every Participant
`java.lang.String`	`getParticipantIdentifiers(int id, java.lang.String format, java.lang.String handle)` Gets the id and chosen identifier of every Participant
`java.lang.String`	`getParticipantIdentifiers(java.lang.String handle)` Gets the id and fullname of every Participant
`java.lang.String`	`getParticipantIdentifiers(java.lang.String format, java.lang.String handle)` Gets the id and chosen identifier of every Participant
`java.lang.String`	`getParticipantPositions(java.lang.String id, java.lang.String handle)` Gets all the Positions held by the specified Participant
`java.lang.String`	`getParticipantRoles(java.lang.String id, java.lang.String handle)` Gets all the Roles the specified Participant is a member of
`java.lang.String`	`getParticipants(java.lang.String handle)` Gets an XML list of all Participants known to the service
`java.lang.String`	`getParticipantsWithCapability(java.lang.String name, java.lang.String handle)` Gets all the participants holding the specified capability (by name)
`java.lang.String`	`getParticipantsWithPosition(java.lang.String name, java.lang.String handle)` Gets all the participants holding the specified position (by name)
`java.lang.String`	`getParticipantsWithRole(java.lang.String name, java.lang.String handle)` Gets all the participants holding the specified role (by name)
`java.lang.String`	`getPosition(java.lang.String id, java.lang.String handle)` Gets the Position with the specified id
`java.lang.String`	`getPositionByName(java.lang.String name, java.lang.String handle)` Gets the Position with the specified name
`java.lang.String`	`getPositionIdentifiers(java.lang.String handle)` Gets the id and name of every Position
`java.lang.String`	`getPositionIdentifiers(java.lang.String format, java.lang.String handle)` Gets the id and name of every Position
`java.lang.String`	`getPositions(java.lang.String handle)` Gets an XML list of all Positions known to the service
`java.lang.String`	`getReferencedParticipantIDs(java.lang.String anyID, java.lang.String handle)` Gets an XML list of participant ids referenced by the id string argument
`java.lang.String`	`getRole(java.lang.String id, java.lang.String handle)` Gets the role with the specified id
`java.lang.String`	`getRoleByName(java.lang.String name, java.lang.String handle)` Gets the role with the specified name
`java.lang.String`	`getRoleIdentifiers(java.lang.String handle)` Gets the id and name of every Role
`java.lang.String`	`getRoleIdentifiers(java.lang.String format, java.lang.String handle)` Gets the id and name of every Role
`java.lang.String`	`getRoles(java.lang.String handle)` Gets an XML list of all Roles known to the service
`java.lang.String`	`getUserPrivileges(java.lang.String id, java.lang.String handle)` Gets the UserPrivileges of the participant with the specified id
`java.lang.String`	`isKnownCapability(java.lang.String capabilityID, java.lang.String handle)` Check if the id passed is that of a known Capability
`java.lang.String`	`isKnownNonHumanCategory(java.lang.String id, java.lang.String handle)` Check if the id passed is that of a known NonHumanCategory
`java.lang.String`	`isKnownNonHumanResource(java.lang.String id, java.lang.String handle)` Check if the id passed is that of a known NonHumanResource
`java.lang.String`	`isKnownOrgGroup(java.lang.String orgGroupID, java.lang.String handle)` Check if the id passed is that of a known OrgGroup
`java.lang.String`	`isKnownParticipant(java.lang.String participantID, java.lang.String handle)` Check if the id passed is that of a known Participant
`java.lang.String`	`isKnownPosition(java.lang.String positionID, java.lang.String handle)` Check if the id passed is that of a known Position
`java.lang.String`	`isKnownRole(java.lang.String roleID, java.lang.String handle)` Check if the id passed is that of a known Role
`void`	`refreshOrgDataSet(java.lang.String handle)` Triggers a reload of org data
`java.lang.String`	`removeCapability(java.lang.String capabilityID, java.lang.String handle)` Removes (deletes) the specified Capability from the Service's org data
`java.lang.String`	`removeNonHumanCategory(java.lang.String id, java.lang.String handle)` Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
`java.lang.String`	`removeNonHumanCategoryByName(java.lang.String category, java.lang.String handle)` Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
`java.lang.String`	`removeNonHumanResource(java.lang.String resourceID, java.lang.String handle)` Removes (deletes) the specified NonHumanResource from the Service's org data
`java.lang.String`	`removeNonHumanSubCategory(java.lang.String id, java.lang.String subcategory, java.lang.String handle)` Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
`java.lang.String`	`removeNonHumanSubCategoryByName(java.lang.String category, java.lang.String subcategory, java.lang.String handle)` Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
`java.lang.String`	`removeOrgGroup(java.lang.String groupID, java.lang.String handle)` Removes (deletes) the specified OrgGroup from the Service's org data
`java.lang.String`	`removeParticipant(java.lang.String participantID, java.lang.String handle)` Removes (deletes) the specified Participant from the Service's org data
`java.lang.String`	`removeParticipantFromCapability(java.lang.String participantID, java.lang.String capabilityID, java.lang.String handle)` Removes (deletes) the specified Participant from the set of Participants holding the specified Capability
`java.lang.String`	`removeParticipantFromPosition(java.lang.String participantID, java.lang.String positionID, java.lang.String handle)` Removes (deletes) the specified Participant from the set of Participants occupying the specified Position
`java.lang.String`	`removeParticipantFromRole(java.lang.String participantID, java.lang.String roleID, java.lang.String handle)` Removes (deletes) the specified Participant from the set of Participants occupying the specified Role
`java.lang.String`	`removePosition(java.lang.String positionID, java.lang.String handle)` Removes (deletes) the specified Position from the Service's org data
`java.lang.String`	`removeRole(java.lang.String roleID, java.lang.String handle)` Removes (deletes) the specified Role from the Service's org data
`void`	`resetOrgDataRefreshRate(int minutes, java.lang.String handle)` (re)sets the timer for automatic org data reloads
`java.lang.String`	`setContainingOrgGroup(java.lang.String groupID, java.lang.String containingGroupID, java.lang.String handle)` Sets the containing OrgGroup for an OrgGroup (i.e.
`java.lang.String`	`setContainingPosition(java.lang.String positionID, java.lang.String containingPositionID, java.lang.String handle)` Sets the containing Position for a Position (i.e.
`java.lang.String`	`setContainingRole(java.lang.String roleID, java.lang.String containingRoleID, java.lang.String handle)` Sets the containing Role for a Role (i.e.
`java.lang.String`	`setParticipantPrivileges(java.lang.String participantID, boolean canChooseItemToStart, boolean canStartConcurrent, boolean canReorder, boolean canViewTeamItems, boolean canViewOrgGroupItems, boolean canChainExecution, boolean canManageCases, java.lang.String handle)` Sets the user privileges of the specified participant individually
`java.lang.String`	`setParticipantPrivileges(java.lang.String participantID, boolean carteblanche, java.lang.String handle)` Sets the user privileges of the specified participant on an 'all on' or 'all off' basis
`java.lang.String`	`setParticipantPrivileges(java.lang.String participantID, java.lang.String bits, java.lang.String handle)` Sets the user privileges of the specified participant individually via a 'bit string'
`java.lang.String`	`setPositionOrgGroup(java.lang.String positionID, java.lang.String groupID, java.lang.String handle)` Sets the containing OrgGroup for a Position (i.e.
`java.lang.String`	`updateCapability(java.lang.String capabilityID, java.lang.String name, java.lang.String description, java.lang.String notes, java.lang.String handle)` Updates a Capability record with the specified values.
`java.lang.String`	`updateNonHumanCategory(java.lang.String categoryID, java.lang.String name, java.lang.String description, java.lang.String notes, java.lang.String handle)` Updates a NonHumanCategory with the specified values.
`java.lang.String`	`updateNonHumanResource(java.lang.String resourceID, java.lang.String name, java.lang.String category, java.lang.String subcategory, java.lang.String description, java.lang.String notes, java.lang.String handle)` Updates a NonHumanResource with the specified values.
`java.lang.String`	`updateOrgGroup(java.lang.String groupID, java.lang.String name, java.lang.String groupType, java.lang.String description, java.lang.String notes, java.lang.String containingGroupID, java.lang.String handle)` Updates an OrgGroup record with the specified values.
`java.lang.String`	`updateParticipant(java.lang.String participantID, java.lang.String userid, java.lang.String password, boolean encrypt, java.lang.String lastname, java.lang.String firstname, boolean admin, java.lang.String description, java.lang.String notes, java.lang.String handle)` Updates a Participant record with the specified values.
`java.lang.String`	`updatePosition(java.lang.String posID, java.lang.String name, java.lang.String positionID, java.lang.String description, java.lang.String notes, java.lang.String orgGroupID, java.lang.String containingPositionID, java.lang.String handle)` Updates a Position record with the specified values.
`java.lang.String`	`updateRole(java.lang.String roleID, java.lang.String name, java.lang.String description, java.lang.String notes, java.lang.String containingRoleID, java.lang.String handle)` Updates a Role record with the specified values.
`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 org.yawlfoundation.yawl.engine.interfce.Interface_Client
executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

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

- Constructor Detail
  - ResourceGatewayClient
```
public ResourceGatewayClient()
```
    empty constructor
  - ResourceGatewayClient
```
public ResourceGatewayClient(java.lang.String uri)
```
    constructor
    
    Parameters:
    
    uri - the uri of the resourceService's gateway
- Method Detail
  - getConstraints
```
public java.lang.String getConstraints(java.lang.String handle)
                                throws java.io.IOException
```
    Gets an XML list of all Resource Constraints known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of constraints as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getFilters
```
public java.lang.String getFilters(java.lang.String handle)
                            throws java.io.IOException
```
    Gets an XML list of all Resource Filters known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of filters as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getAllocators
```
public java.lang.String getAllocators(java.lang.String handle)
                               throws java.io.IOException
```
    Gets an XML list of all Resource Allocators known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of allocators as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getAllSelectors
```
public java.lang.String getAllSelectors(java.lang.String handle)
                                 throws java.io.IOException
```
    Gets a concatenated XML list of all Resource Selectors (i.e. Constraints, Filters and Allocators) known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of allocators as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipants
```
public java.lang.String getParticipants(java.lang.String handle)
                                 throws java.io.IOException
```
    Gets an XML list of all Participants known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of participants as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanResources
```
public java.lang.String getNonHumanResources(java.lang.String handle)
                                      throws java.io.IOException
```
    Gets an XML list of all NonHumanResources known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of NonHumanResources as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getRoles
```
public java.lang.String getRoles(java.lang.String handle)
                          throws java.io.IOException
```
    Gets an XML list of all Roles known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of roles as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getCapabilities
```
public java.lang.String getCapabilities(java.lang.String handle)
                                 throws java.io.IOException
```
    Gets an XML list of all Capabilities known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of capabilities as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getPositions
```
public java.lang.String getPositions(java.lang.String handle)
                              throws java.io.IOException
```
    Gets an XML list of all Positions known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of positions as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getOrgGroups
```
public java.lang.String getOrgGroups(java.lang.String handle)
                              throws java.io.IOException
```
    Gets an XML list of all OrgGroups known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of org groups as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getAllParticipantNames
```
public java.lang.String getAllParticipantNames(java.lang.String handle)
                                        throws java.io.IOException
```
    Gets an XML list of the full name of each Participant known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of participant names as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getAllRoleNames
```
public java.lang.String getAllRoleNames(java.lang.String handle)
                                 throws java.io.IOException
```
    Gets an XML list of the name of each Role known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of role names as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getAllNonHumanResourceNames
```
public java.lang.String getAllNonHumanResourceNames(java.lang.String handle)
                                             throws java.io.IOException
```
    Gets an XML list of the name of each NonHumanResource known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of NonHumanResource names as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getActiveParticipants
```
public java.lang.String getActiveParticipants(java.lang.String handle)
                                       throws java.io.IOException
```
    Gets an XML list of the Participants that are currently logged on to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of participants as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipant
```
public java.lang.String getParticipant(java.lang.String id,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Gets a specific Participant
    
    Parameters:
    
    id - the id of the participant to retrieve
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the participant
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanResource
```
public java.lang.String getNonHumanResource(java.lang.String id,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Gets a specific NonHumanResource
    
    Parameters:
    
    id - the id of the NonHumanResource to retrieve
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the NonHumanResource
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantRoles
```
public java.lang.String getParticipantRoles(java.lang.String id,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Gets all the Roles the specified Participant is a member of
    
    Parameters:
    
    id - the id of the participant
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the roles
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantCapabilities
```
public java.lang.String getParticipantCapabilities(java.lang.String id,
                                                   java.lang.String handle)
                                            throws java.io.IOException
```
    Gets all the Capabilities held by the specified Participant
    
    Parameters:
    
    id - the id of the participant
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the capabilities
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantPositions
```
public java.lang.String getParticipantPositions(java.lang.String id,
                                                java.lang.String handle)
                                         throws java.io.IOException
```
    Gets all the Positions held by the specified Participant
    
    Parameters:
    
    id - the id of the participant
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the positions
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantsWithRole
```
public java.lang.String getParticipantsWithRole(java.lang.String name,
                                                java.lang.String handle)
                                         throws java.io.IOException
```
    Gets all the participants holding the specified role (by name)
    
    Parameters:
    
    name - the name of the role (not the id)
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the participants
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantsWithPosition
```
public java.lang.String getParticipantsWithPosition(java.lang.String name,
                                                    java.lang.String handle)
                                             throws java.io.IOException
```
    Gets all the participants holding the specified position (by name)
    
    Parameters:
    
    name - the name of the position (not the id)
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the participants
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantsWithCapability
```
public java.lang.String getParticipantsWithCapability(java.lang.String name,
                                                      java.lang.String handle)
                                               throws java.io.IOException
```
    Gets all the participants holding the specified capability (by name)
    
    Parameters:
    
    name - the name of the capability (not the id)
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the participants
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantFromUserID
```
public java.lang.String getParticipantFromUserID(java.lang.String userID,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Gets the participant with the specified user id
    
    Parameters:
    
    userID - the userid to match to a participant
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the participant, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getRole
```
public java.lang.String getRole(java.lang.String id,
                                java.lang.String handle)
                         throws java.io.IOException
```
    Gets the role with the specified id
    
    Parameters:
    
    id - the id of the role to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the role, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getRoleByName
```
public java.lang.String getRoleByName(java.lang.String name,
                                      java.lang.String handle)
                               throws java.io.IOException
```
    Gets the role with the specified name
    
    Parameters:
    
    name - the name of the role to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the role, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getCapability
```
public java.lang.String getCapability(java.lang.String id,
                                      java.lang.String handle)
                               throws java.io.IOException
```
    Gets the Capability with the specified id
    
    Parameters:
    
    id - the id of the Capability to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Capability, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getCapabilityByName
```
public java.lang.String getCapabilityByName(java.lang.String name,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Gets the Capability with the specified name
    
    Parameters:
    
    name - the name of the Capability to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Capability, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getPosition
```
public java.lang.String getPosition(java.lang.String id,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Gets the Position with the specified id
    
    Parameters:
    
    id - the id of the Position to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Position, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getPositionByName
```
public java.lang.String getPositionByName(java.lang.String name,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Gets the Position with the specified name
    
    Parameters:
    
    name - the name of the Position to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Position, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getOrgGroup
```
public java.lang.String getOrgGroup(java.lang.String id,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Gets the OrgGroup with the specified id
    
    Parameters:
    
    id - the id of the OrgGroup to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the OrgGroup, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getOrgGroupByName
```
public java.lang.String getOrgGroupByName(java.lang.String name,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Gets the OrgGroup with the specified name
    
    Parameters:
    
    name - the name of the OrgGroup to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the OrgGroup, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanResourceByName
```
public java.lang.String getNonHumanResourceByName(java.lang.String name,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Gets the NonHumanResource with the specified name
    
    Parameters:
    
    name - the name of the NonHumanResource to get
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the NonHumanResource, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantIdentifiers
```
public java.lang.String getParticipantIdentifiers(int id,
                                                  java.lang.String format,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Gets the id and chosen identifier of every Participant
    
    Parameters:
    
    id - a valid ResourceDataSet.Identifier; one of: FullName, ReverseFullName, LastName or Userid (0..3)
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    a string describing the Participant id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantIdentifiers
```
public java.lang.String getParticipantIdentifiers(java.lang.String format,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Gets the id and chosen identifier of every Participant
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    a string describing the Participant id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantIdentifiers
```
public java.lang.String getParticipantIdentifiers(int id,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Gets the id and chosen identifier of every Participant
    
    Parameters:
    
    id - a valid ResourceDataSet.Identifier; one of: FullName, ReverseFullName, LastName or Userid (0..3)
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Participant id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getParticipantIdentifiers
```
public java.lang.String getParticipantIdentifiers(java.lang.String handle)
                                           throws java.io.IOException
```
    Gets the id and fullname of every Participant
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Participant id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanResourceIdentifiers
```
public java.lang.String getNonHumanResourceIdentifiers(java.lang.String handle)
                                                throws java.io.IOException
```
    Gets the id and name of every NonHumanResource
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the NonHumanResource id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanResourceIdentifiers
```
public java.lang.String getNonHumanResourceIdentifiers(java.lang.String format,
                                                       java.lang.String handle)
                                                throws java.io.IOException
```
    Gets the id and name of every NonHumanResource
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the NonHumanResource id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getRoleIdentifiers
```
public java.lang.String getRoleIdentifiers(java.lang.String handle)
                                    throws java.io.IOException
```
    Gets the id and name of every Role
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Role id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getRoleIdentifiers
```
public java.lang.String getRoleIdentifiers(java.lang.String format,
                                           java.lang.String handle)
                                    throws java.io.IOException
```
    Gets the id and name of every Role
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Role id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getPositionIdentifiers
```
public java.lang.String getPositionIdentifiers(java.lang.String handle)
                                        throws java.io.IOException
```
    Gets the id and name of every Position
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Position id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getPositionIdentifiers
```
public java.lang.String getPositionIdentifiers(java.lang.String format,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Gets the id and name of every Position
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Position id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getCapabilityIdentifiers
```
public java.lang.String getCapabilityIdentifiers(java.lang.String handle)
                                          throws java.io.IOException
```
    Gets the id and name of every Capability
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Capability id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getCapabilityIdentifiers
```
public java.lang.String getCapabilityIdentifiers(java.lang.String format,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Gets the id and name of every Capability
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the Capability id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getOrgGroupIdentifiers
```
public java.lang.String getOrgGroupIdentifiers(java.lang.String handle)
                                        throws java.io.IOException
```
    Gets the id and name of every OrgGroup
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the OrgGroup id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getOrgGroupIdentifiers
```
public java.lang.String getOrgGroupIdentifiers(java.lang.String format,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Gets the id and name of every OrgGroup
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the OrgGroup id/name pairs, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getUserPrivileges
```
public java.lang.String getUserPrivileges(java.lang.String id,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Gets the UserPrivileges of the participant with the specified id
    
    Parameters:
    
    id - the id of the Participant to get the user privileges of
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the UserPrivileges, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanCategory
```
public java.lang.String getNonHumanCategory(java.lang.String id,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Gets the NonHumanCategory with the specified id
    
    Parameters:
    
    id - a valid NonHumanCategory identifier
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the category, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanCategoryByName
```
public java.lang.String getNonHumanCategoryByName(java.lang.String name,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Gets the NonHumanCategory with the specified name
    
    Parameters:
    
    name - a valid NonHumanCategory name
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the category, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanCategories
```
public java.lang.String getNonHumanCategories(java.lang.String handle)
                                       throws java.io.IOException
```
    Gets all the NonHumanResource categories known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanCategories
```
public java.lang.String getNonHumanCategories(java.lang.String format,
                                              java.lang.String handle)
                                       throws java.io.IOException
```
    Gets all the NonHumanResource categories known to the service
    
    Parameters:
    
    format - how to format the output; valid values are "XML" or "JSON"
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanSubCategories
```
public java.lang.String getNonHumanSubCategories(java.lang.String id,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Gets all the NonHumanResource sub-categories for the specified category identifier
    
    Parameters:
    
    id - the category id to get the sub-categories for
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanSubCategories
```
public java.lang.String getNonHumanSubCategories(java.lang.String id,
                                                 java.lang.String format,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Gets all the NonHumanResource sub-categories for the specified category identifier
    
    Parameters:
    
    id - the category id to get the sub-categories for
    
    format - how to format the output; valid values are "XML" or "JSON" - a null value defaults to XML
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanSubCategoriesByName
```
public java.lang.String getNonHumanSubCategoriesByName(java.lang.String category,
                                                       java.lang.String handle)
                                                throws java.io.IOException
```
    Gets all the NonHumanResource sub-categories for the specified category name
    
    Parameters:
    
    category - the category to get the sub-categories for
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanSubCategoriesByName
```
public java.lang.String getNonHumanSubCategoriesByName(java.lang.String category,
                                                       java.lang.String format,
                                                       java.lang.String handle)
                                                throws java.io.IOException
```
    Gets all the NonHumanResource sub-categories for the specified category name
    
    Parameters:
    
    category - the category to get the sub-categories for
    
    format - how to format the output; valid values are "XML" or "JSON" - a null value defaults to XML
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getNonHumanCategorySet
```
public java.lang.String getNonHumanCategorySet(java.lang.String handle)
                                        throws java.io.IOException
```
    Gets all the NonHumanResource categories known to the service, together with each of their subcategories
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    an XML string describing the categories, or an appropriate error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - validateUserCredentials
```
public java.lang.String validateUserCredentials(java.lang.String userid,
                                                java.lang.String password,
                                                boolean checkForAdmin,
                                                java.lang.String handle)
                                         throws java.io.IOException
```
    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
  - getCodelets
```
public java.lang.String getCodelets(java.lang.String handle)
                             throws java.io.IOException
```
    Gets an XML list of the Codelets known to the service
    
    Parameters:
    
    handle - a valid session handle
    
    Returns:
    
    the list of codelets as an XML string
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getCodeletParameters
```
public java.lang.String getCodeletParameters(java.lang.String codeletName,
                                             java.lang.String handle)
                                      throws java.io.IOException
```
    Gets an XML list of the required parameters for the specified codelet
    
    Parameters:
    
    codeletName - the simple name of the codelet
    
    handle - a valid session handle
    
    Returns:
    
    the list of the codelet's required parameters as an XML string, or an error message if the codelet could not be found
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - getReferencedParticipantIDs
```
public java.lang.String getReferencedParticipantIDs(java.lang.String anyID,
                                                    java.lang.String handle)
                                             throws java.io.IOException
```
    Gets an XML list 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 list 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 list
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownParticipant
```
public java.lang.String isKnownParticipant(java.lang.String participantID,
                                           java.lang.String handle)
                                    throws java.io.IOException
```
    Check if the id passed is that of a known Participant
    
    Parameters:
    
    participantID - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownRole
```
public java.lang.String isKnownRole(java.lang.String roleID,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Check if the id passed is that of a known Role
    
    Parameters:
    
    roleID - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownCapability
```
public java.lang.String isKnownCapability(java.lang.String capabilityID,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Check if the id passed is that of a known Capability
    
    Parameters:
    
    capabilityID - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownPosition
```
public java.lang.String isKnownPosition(java.lang.String positionID,
                                        java.lang.String handle)
                                 throws java.io.IOException
```
    Check if the id passed is that of a known Position
    
    Parameters:
    
    positionID - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownOrgGroup
```
public java.lang.String isKnownOrgGroup(java.lang.String orgGroupID,
                                        java.lang.String handle)
                                 throws java.io.IOException
```
    Check if the id passed is that of a known OrgGroup
    
    Parameters:
    
    orgGroupID - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownNonHumanResource
```
public java.lang.String isKnownNonHumanResource(java.lang.String id,
                                                java.lang.String handle)
                                         throws java.io.IOException
```
    Check if the id passed is that of a known NonHumanResource
    
    Parameters:
    
    id - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - isKnownNonHumanCategory
```
public java.lang.String isKnownNonHumanCategory(java.lang.String id,
                                                java.lang.String handle)
                                         throws java.io.IOException
```
    Check if the id passed is that of a known NonHumanCategory
    
    Parameters:
    
    id - the id to check
    
    handle - a valid session handle
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - connect
```
public java.lang.String connect(java.lang.String userID,
                                java.lang.String password)
                         throws java.io.IOException
```
    Connects an external entity to the resource service
    
    Parameters:
    
    userID - the userid
    
    password - the corresponding password
    
    Returns:
    
    a sessionHandle if successful, or a failure message if not
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - checkConnection
```
public java.lang.String checkConnection(java.lang.String handle)
                                 throws java.io.IOException
```
    Check that a session handle is active
    
    Parameters:
    
    handle - the session handle to check
    
    Returns:
    
    "true" if the id is valid, "false" if otherwise
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - disconnect
```
public void disconnect(java.lang.String handle)
                throws java.io.IOException
```
    Disconnects an external entity from the resource service
    
    Parameters:
    
    handle - the sessionHandle to disconnect
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addParticipant
```
public java.lang.String addParticipant(java.lang.String userid,
                                       java.lang.String password,
                                       boolean encrypt,
                                       java.lang.String lastname,
                                       java.lang.String firstname,
                                       boolean admin,
                                       java.lang.String description,
                                       java.lang.String notes,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Adds a new Participant to the Resource Service's org data
    
    Parameters:
    
    userid - - must not already exist in the service's org data
    
    password -
    
    encrypt - - if true, will encrypt the password before it is stored
    
    lastname -
    
    firstname -
    
    admin - - if true, will set this Participant as an administrator
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    if successful, the id of the newly added participant; if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addNonHumanResource
```
public java.lang.String addNonHumanResource(java.lang.String name,
                                            java.lang.String category,
                                            java.lang.String subcategory,
                                            java.lang.String description,
                                            java.lang.String notes,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Adds a new NonHumanResource to the Resource Service's org data
    
    Parameters:
    
    name - - must not already exist in the service's org data
    
    category -
    
    subcategory -
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    if successful, the id of the newly added NonHumanResource; if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addCapability
```
public java.lang.String addCapability(java.lang.String name,
                                      java.lang.String description,
                                      java.lang.String notes,
                                      java.lang.String handle)
                               throws java.io.IOException
```
    Adds a new Capability to the Resource Service's org data
    
    Parameters:
    
    name - - must not already exist in the service's org data
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    if successful, the id of the newly added capability; if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addRole
```
public java.lang.String addRole(java.lang.String name,
                                java.lang.String description,
                                java.lang.String notes,
                                java.lang.String containingRoleID,
                                java.lang.String handle)
                         throws java.io.IOException
```
    Adds a new Role to the Resource Service's org data
    
    Parameters:
    
    name - - must not already exist in the service's org data
    
    description -
    
    notes -
    
    containingRoleID - the id of the Role this Role will 'belong to' (may be null)
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    if successful, the id of the newly added role; if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addPosition
```
public java.lang.String addPosition(java.lang.String name,
                                    java.lang.String positionID,
                                    java.lang.String description,
                                    java.lang.String notes,
                                    java.lang.String orgGroupID,
                                    java.lang.String containingPositionID,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Adds a new Position to the Resource Service's org data
    
    Parameters:
    
    name - - must not already exist in the service's org data
    
    description -
    
    notes -
    
    orgGroupID - the id of the OrgGroup this Position will 'belong to' (may be null)
    
    containingPositionID - the id of the Position this Position will 'report to' (may be null)
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    if successful, the id of the newly added position; if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addOrgGroup
```
public java.lang.String addOrgGroup(java.lang.String name,
                                    java.lang.String groupType,
                                    java.lang.String description,
                                    java.lang.String notes,
                                    java.lang.String containingGroupID,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    Adds a new OrgGroup to the Resource Service's org data
    
    Parameters:
    
    name - - must not already exist in the service's org data
    
    groupType - one of the OrgGroup.GroupType's
    
    description -
    
    notes -
    
    containingGroupID - the id of the OrgGroup this OrgGroup will 'belong to' (may be null)
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    if successful, the id of the newly added group; if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addParticipantToRole
```
public java.lang.String addParticipantToRole(java.lang.String participantID,
                                             java.lang.String roleID,
                                             java.lang.String handle)
                                      throws java.io.IOException
```
    Adds a Participant to the set of Participants occupying a Role
    
    Parameters:
    
    participantID - the (existing) id of the Participant to add
    
    roleID - the (existing) id of the Role to add the Participant to
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addParticipantToCapability
```
public java.lang.String addParticipantToCapability(java.lang.String participantID,
                                                   java.lang.String capabilityID,
                                                   java.lang.String handle)
                                            throws java.io.IOException
```
    Adds a Participant to the set of Participants holding a Capability
    
    Parameters:
    
    participantID - the (existing) id of the Participant to add
    
    capabilityID - the (existing) id of the Capability to add the Participant to
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addParticipantToPosition
```
public java.lang.String addParticipantToPosition(java.lang.String participantID,
                                                 java.lang.String positionID,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Adds a Participant to the set of Participants holding a Position
    
    Parameters:
    
    participantID - the (existing) id of the Participant to add
    
    positionID - the (existing) id of the Position to add the Participant to
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addNonHumanCategory
```
public java.lang.String addNonHumanCategory(java.lang.String category,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Adds a new category to the set of NonHumanResource categories
    
    Parameters:
    
    category - the category name to add
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a String conversion of the (long) category key value, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addNonHumanSubCategoryByName
```
public java.lang.String addNonHumanSubCategoryByName(java.lang.String category,
                                                     java.lang.String subcategory,
                                                     java.lang.String handle)
                                              throws java.io.IOException
```
    Adds a new subcategory to the specified NonHumanResource category. If the category does not exist, it will be created
    
    Parameters:
    
    category - the (existing) category name
    
    subcategory - the subcategory name to add
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - addNonHumanSubCategory
```
public java.lang.String addNonHumanSubCategory(java.lang.String id,
                                               java.lang.String subcategory,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Adds a new subcategory to the specified NonHumanResource category
    
    Parameters:
    
    id - the id of the (existing) category
    
    subcategory - the subcategory name to add
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updateParticipant
```
public java.lang.String updateParticipant(java.lang.String participantID,
                                          java.lang.String userid,
                                          java.lang.String password,
                                          boolean encrypt,
                                          java.lang.String lastname,
                                          java.lang.String firstname,
                                          boolean admin,
                                          java.lang.String description,
                                          java.lang.String notes,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Updates a Participant record with the specified values. Note that besides participantid and handle, all other String parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    participantID - the (existing) id of the Participant
    
    userid -
    
    password -
    
    encrypt - - if true, will encrypt the password before it is stored
    
    lastname -
    
    firstname -
    
    admin - - if true, will set this Participant as an administrator
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updateNonHumanResource
```
public java.lang.String updateNonHumanResource(java.lang.String resourceID,
                                               java.lang.String name,
                                               java.lang.String category,
                                               java.lang.String subcategory,
                                               java.lang.String description,
                                               java.lang.String notes,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Updates a NonHumanResource with the specified values. Note that besides resourceID and handle, all other String parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    resourceID - - the (existing) id of the NonHumanResource
    
    name -
    
    category -
    
    subcategory -
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updateCapability
```
public java.lang.String updateCapability(java.lang.String capabilityID,
                                         java.lang.String name,
                                         java.lang.String description,
                                         java.lang.String notes,
                                         java.lang.String handle)
                                  throws java.io.IOException
```
    Updates a Capability record with the specified values. Note that besides capabilityID and handle, all other parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    capabilityID - the (existing) id of the Capability
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updateRole
```
public java.lang.String updateRole(java.lang.String roleID,
                                   java.lang.String name,
                                   java.lang.String description,
                                   java.lang.String notes,
                                   java.lang.String containingRoleID,
                                   java.lang.String handle)
                            throws java.io.IOException
```
    Updates a Role record with the specified values. Note that besides roleID and handle, all other parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    roleID - the (existing) id of the Capability
    
    name -
    
    description -
    
    notes -
    
    containingRoleID - the id of the Role this Role will 'belong to'
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updatePosition
```
public java.lang.String updatePosition(java.lang.String posID,
                                       java.lang.String name,
                                       java.lang.String positionID,
                                       java.lang.String description,
                                       java.lang.String notes,
                                       java.lang.String orgGroupID,
                                       java.lang.String containingPositionID,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Updates a Position record with the specified values. Note that besides posID and handle, all other parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    posID - the (existing) id of the Position
    
    name -
    
    description -
    
    notes -
    
    orgGroupID - the id of the OrgGroup this Position will 'belong to'
    
    containingPositionID - the id of the Position this Position will 'report to'
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updateOrgGroup
```
public java.lang.String updateOrgGroup(java.lang.String groupID,
                                       java.lang.String name,
                                       java.lang.String groupType,
                                       java.lang.String description,
                                       java.lang.String notes,
                                       java.lang.String containingGroupID,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Updates an OrgGroup record with the specified values. Note that besides groupID and handle, all other parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    groupID - the (existing) id of the OrgGroup
    
    name -
    
    groupType - one of the OrgGroup.GroupType's
    
    description -
    
    notes -
    
    containingGroupID - the id of the OrgGroup this OrgGroup will 'belong to'
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - updateNonHumanCategory
```
public java.lang.String updateNonHumanCategory(java.lang.String categoryID,
                                               java.lang.String name,
                                               java.lang.String description,
                                               java.lang.String notes,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Updates a NonHumanCategory with the specified values. Note that besides categoryid and handle, all other String parameters may be null, which will indicate that the current value for that field is not to be updated (ie. the existing value is maintained).
    
    Parameters:
    
    categoryID - the (existing) id of the NonHumanCategory
    
    name -
    
    description -
    
    notes -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeParticipant
```
public java.lang.String removeParticipant(java.lang.String participantID,
                                          java.lang.String handle)
                                   throws java.io.IOException
```
    Removes (deletes) the specified Participant from the Service's org data
    
    Parameters:
    
    participantID - the id of the Participant to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeNonHumanResource
```
public java.lang.String removeNonHumanResource(java.lang.String resourceID,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Removes (deletes) the specified NonHumanResource from the Service's org data
    
    Parameters:
    
    resourceID - the id of the Participant to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeCapability
```
public java.lang.String removeCapability(java.lang.String capabilityID,
                                         java.lang.String handle)
                                  throws java.io.IOException
```
    Removes (deletes) the specified Capability from the Service's org data
    
    Parameters:
    
    capabilityID - the id of the Capability to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeRole
```
public java.lang.String removeRole(java.lang.String roleID,
                                   java.lang.String handle)
                            throws java.io.IOException
```
    Removes (deletes) the specified Role from the Service's org data
    
    Parameters:
    
    roleID - the id of the Role to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removePosition
```
public java.lang.String removePosition(java.lang.String positionID,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Removes (deletes) the specified Position from the Service's org data
    
    Parameters:
    
    positionID - the id of the Position to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeOrgGroup
```
public java.lang.String removeOrgGroup(java.lang.String groupID,
                                       java.lang.String handle)
                                throws java.io.IOException
```
    Removes (deletes) the specified OrgGroup from the Service's org data
    
    Parameters:
    
    groupID - the id of the OrgGroup to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeParticipantFromRole
```
public java.lang.String removeParticipantFromRole(java.lang.String participantID,
                                                  java.lang.String roleID,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Removes (deletes) the specified Participant from the set of Participants occupying the specified Role
    
    Parameters:
    
    participantID - the id of the Participant to remove
    
    roleID - the id of the Role to remove the Particpant from
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeParticipantFromCapability
```
public java.lang.String removeParticipantFromCapability(java.lang.String participantID,
                                                        java.lang.String capabilityID,
                                                        java.lang.String handle)
                                                 throws java.io.IOException
```
    Removes (deletes) the specified Participant from the set of Participants holding the specified Capability
    
    Parameters:
    
    participantID - the id of the Participant to remove
    
    capabilityID - the id of the Capability to remove the Particpant from
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeParticipantFromPosition
```
public java.lang.String removeParticipantFromPosition(java.lang.String participantID,
                                                      java.lang.String positionID,
                                                      java.lang.String handle)
                                               throws java.io.IOException
```
    Removes (deletes) the specified Participant from the set of Participants occupying the specified Position
    
    Parameters:
    
    participantID - the id of the Participant to remove
    
    positionID - the id of the Position to remove the Particpant from
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeNonHumanCategory
```
public java.lang.String removeNonHumanCategory(java.lang.String id,
                                               java.lang.String handle)
                                        throws java.io.IOException
```
    Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
    
    Parameters:
    
    id - the identifier of the category to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeNonHumanCategoryByName
```
public java.lang.String removeNonHumanCategoryByName(java.lang.String category,
                                                     java.lang.String handle)
                                              throws java.io.IOException
```
    Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
    
    Parameters:
    
    category - the name of the category to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeNonHumanSubCategoryByName
```
public java.lang.String removeNonHumanSubCategoryByName(java.lang.String category,
                                                        java.lang.String subcategory,
                                                        java.lang.String handle)
                                                 throws java.io.IOException
```
    Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
    
    Parameters:
    
    category - the name of the category of which the subcategory is a member
    
    subcategory - the name of the subcategory to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - removeNonHumanSubCategory
```
public java.lang.String removeNonHumanSubCategory(java.lang.String id,
                                                  java.lang.String subcategory,
                                                  java.lang.String handle)
                                           throws java.io.IOException
```
    Removes the specified category from the set of NonHumanResource categories; any sub-categories of the specified categories are also removed.
    
    Parameters:
    
    id - the identifier of the category of which the subcategory is a member
    
    subcategory - the name of the subcategory to remove
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setContainingRole
```
public java.lang.String setContainingRole(java.lang.String roleID,
                                          java.lang.String containingRoleID,
                                          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:
    
    roleID - the id of the 'child' Role
    
    containingRoleID - the id of the containing or parent Role that encapsulates the 'child' Role
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setContainingOrgGroup
```
public java.lang.String setContainingOrgGroup(java.lang.String groupID,
                                              java.lang.String containingGroupID,
                                              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:
    
    groupID - the id of the 'child' OrgGroup
    
    containingGroupID - the id of the containing or parent OrgGroup that encapsulates the 'child' OrgGroup
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setContainingPosition
```
public java.lang.String setContainingPosition(java.lang.String positionID,
                                              java.lang.String containingPositionID,
                                              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:
    
    positionID - the id of the 'child' Position
    
    containingPositionID - the id of the containing or parent Position that encapsulates the 'child' Position
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setPositionOrgGroup
```
public java.lang.String setPositionOrgGroup(java.lang.String positionID,
                                            java.lang.String groupID,
                                            java.lang.String handle)
                                     throws java.io.IOException
```
    Sets the containing OrgGroup for a Position (i.e. the OrgGroup the Position 'belongs to')
    
    Parameters:
    
    positionID - the id of the Position
    
    groupID - the id of the containing OrgGroup
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setParticipantPrivileges
```
public java.lang.String setParticipantPrivileges(java.lang.String participantID,
                                                 boolean canChooseItemToStart,
                                                 boolean canStartConcurrent,
                                                 boolean canReorder,
                                                 boolean canViewTeamItems,
                                                 boolean canViewOrgGroupItems,
                                                 boolean canChainExecution,
                                                 boolean canManageCases,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Sets the user privileges of the specified participant individually
    
    Parameters:
    
    participantID - the (existing) id of the participant
    
    canChooseItemToStart -
    
    canStartConcurrent -
    
    canReorder -
    
    canViewTeamItems -
    
    canViewOrgGroupItems -
    
    canChainExecution -
    
    canManageCases -
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setParticipantPrivileges
```
public java.lang.String setParticipantPrivileges(java.lang.String participantID,
                                                 java.lang.String bits,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Sets the user privileges of the specified participant individually via a 'bit string'
    
    Parameters:
    
    participantID - the (existing) id of the participant
    
    bits - an eight character string where each character corresponds to a privilege (see the alternate setParticipantPrivileges() method for the ordering). For each privilege, a character value of '1' indicates that the privilege is to be granted and a character of any other value indicates that the privilege is to be denied. The last character overrides all other privileges, so that a value of '1' in the last position grants all privileges, while any other value in the last position defers to the individual settings of each privilege.
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - setParticipantPrivileges
```
public java.lang.String setParticipantPrivileges(java.lang.String participantID,
                                                 boolean carteblanche,
                                                 java.lang.String handle)
                                          throws java.io.IOException
```
    Sets the user privileges of the specified participant on an 'all on' or 'all off' basis
    
    Parameters:
    
    participantID - the (existing) id of the participant
    
    carteblanche - if true, grants the participant all user privileges; if false, denies the participant all user privileges
    
    handle - a current sessionhandle with admin privileges
    
    Returns:
    
    a message indicating success, or if not successful, an explanatory error message
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - refreshOrgDataSet
```
public void refreshOrgDataSet(java.lang.String handle)
                       throws java.io.IOException
```
    Triggers a reload of org data
    
    Parameters:
    
    handle - a valid session handle with admin access
    
    Throws:
    
    java.io.IOException - if the service can't be reached
  - resetOrgDataRefreshRate
```
public void resetOrgDataRefreshRate(int minutes,
                                    java.lang.String handle)
                             throws java.io.IOException
```
    (re)sets the timer for automatic org data reloads
    
    Parameters:
    
    minutes - the number of minutes to wait between refreshes
    
    handle - a valid session handle with admin access
    
    Throws:
    
    java.io.IOException - if the service can't be reached

Class ResourceGatewayClient

Constructor Summary

Method Summary

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

Methods inherited from class java.lang.Object

Constructor Detail

ResourceGatewayClient

ResourceGatewayClient

Method Detail

getConstraints

getFilters

getAllocators

getAllSelectors

getParticipants

getNonHumanResources

getRoles

getCapabilities

getPositions

getOrgGroups

getAllParticipantNames

getAllRoleNames

getAllNonHumanResourceNames

getActiveParticipants

getParticipant

getNonHumanResource

getParticipantRoles

getParticipantCapabilities

getParticipantPositions

getParticipantsWithRole

getParticipantsWithPosition

getParticipantsWithCapability

getParticipantFromUserID

getRole

getRoleByName

getCapability

getCapabilityByName

getPosition

getPositionByName

getOrgGroup

getOrgGroupByName

getNonHumanResourceByName

getParticipantIdentifiers

getParticipantIdentifiers

getParticipantIdentifiers

getParticipantIdentifiers

getNonHumanResourceIdentifiers

getNonHumanResourceIdentifiers

getRoleIdentifiers

getRoleIdentifiers

getPositionIdentifiers

getPositionIdentifiers

getCapabilityIdentifiers

getCapabilityIdentifiers

getOrgGroupIdentifiers

getOrgGroupIdentifiers

getUserPrivileges

getNonHumanCategory

getNonHumanCategoryByName

getNonHumanCategories

getNonHumanCategories

getNonHumanSubCategories

getNonHumanSubCategories

getNonHumanSubCategoriesByName

getNonHumanSubCategoriesByName

getNonHumanCategorySet

validateUserCredentials

getCodelets

getCodeletParameters

getReferencedParticipantIDs

isKnownParticipant

isKnownRole

isKnownCapability

isKnownPosition

isKnownOrgGroup

isKnownNonHumanResource

isKnownNonHumanCategory

connect

checkConnection

disconnect

addParticipant