org.yawlfoundation.yawl.resourcing.rsInterface
Class ResourceGatewayClient

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

Parameters:
uri - the uri of the resourceService's gateway
Method Detail

getConstraints

public String getConstraints(String handle)
                      throws 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:
IOException - if the service can't be reached

getFilters

public String getFilters(String handle)
                  throws 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:
IOException - if the service can't be reached

getAllocators

public String getAllocators(String handle)
                     throws 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:
IOException - if the service can't be reached

getAllSelectors

public String getAllSelectors(String handle)
                       throws 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:
IOException - if the service can't be reached

getParticipants

public String getParticipants(String handle)
                       throws 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:
IOException - if the service can't be reached

getNonHumanResources

public String getNonHumanResources(String handle)
                            throws 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:
IOException - if the service can't be reached

getRoles

public String getRoles(String handle)
                throws 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:
IOException - if the service can't be reached

getCapabilities

public String getCapabilities(String handle)
                       throws 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:
IOException - if the service can't be reached

getPositions

public String getPositions(String handle)
                    throws 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:
IOException - if the service can't be reached

getOrgGroups

public String getOrgGroups(String handle)
                    throws 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:
IOException - if the service can't be reached

getAllParticipantNames

public String getAllParticipantNames(String handle)
                              throws 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:
IOException - if the service can't be reached

getAllRoleNames

public String getAllRoleNames(String handle)
                       throws 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:
IOException - if the service can't be reached

getAllNonHumanResourceNames

public String getAllNonHumanResourceNames(String handle)
                                   throws 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:
IOException - if the service can't be reached

getActiveParticipants

public String getActiveParticipants(String handle)
                             throws 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:
IOException - if the service can't be reached

getParticipant

public String getParticipant(String id,
                             String handle)
                      throws 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:
IOException - if the service can't be reached

getNonHumanResource

public String getNonHumanResource(String id,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

getParticipantRoles

public String getParticipantRoles(String id,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

getParticipantCapabilities

public String getParticipantCapabilities(String id,
                                         String handle)
                                  throws 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:
IOException - if the service can't be reached

getParticipantPositions

public String getParticipantPositions(String id,
                                      String handle)
                               throws 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:
IOException - if the service can't be reached

getParticipantsWithRole

public String getParticipantsWithRole(String name,
                                      String handle)
                               throws 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:
IOException - if the service can't be reached

getParticipantsWithPosition

public String getParticipantsWithPosition(String name,
                                          String handle)
                                   throws 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:
IOException - if the service can't be reached

getParticipantsWithCapability

public String getParticipantsWithCapability(String name,
                                            String handle)
                                     throws 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:
IOException - if the service can't be reached

getParticipantFromUserID

public String getParticipantFromUserID(String userID,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

getRole

public String getRole(String id,
                      String handle)
               throws 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:
IOException - if the service can't be reached

getRoleByName

public String getRoleByName(String name,
                            String handle)
                     throws 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:
IOException - if the service can't be reached

getCapability

public String getCapability(String id,
                            String handle)
                     throws 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:
IOException - if the service can't be reached

getCapabilityByName

public String getCapabilityByName(String name,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

getPosition

public String getPosition(String id,
                          String handle)
                   throws 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:
IOException - if the service can't be reached

getPositionByName

public String getPositionByName(String name,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

getOrgGroup

public String getOrgGroup(String id,
                          String handle)
                   throws 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:
IOException - if the service can't be reached

getOrgGroupByName

public String getOrgGroupByName(String name,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

getNonHumanResourceByName

public String getNonHumanResourceByName(String name,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

getParticipantIdentifiers

public String getParticipantIdentifiers(int id,
                                        String format,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

getParticipantIdentifiers

public String getParticipantIdentifiers(String format,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

getParticipantIdentifiers

public String getParticipantIdentifiers(int id,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

getParticipantIdentifiers

public String getParticipantIdentifiers(String handle)
                                 throws 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:
IOException - if the service can't be reached

getNonHumanResourceIdentifiers

public String getNonHumanResourceIdentifiers(String handle)
                                      throws 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:
IOException - if the service can't be reached

getNonHumanResourceIdentifiers

public String getNonHumanResourceIdentifiers(String format,
                                             String handle)
                                      throws 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:
IOException - if the service can't be reached

getRoleIdentifiers

public String getRoleIdentifiers(String handle)
                          throws 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:
IOException - if the service can't be reached

getRoleIdentifiers

public String getRoleIdentifiers(String format,
                                 String handle)
                          throws 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:
IOException - if the service can't be reached

getPositionIdentifiers

public String getPositionIdentifiers(String handle)
                              throws 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:
IOException - if the service can't be reached

getPositionIdentifiers

public String getPositionIdentifiers(String format,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

getCapabilityIdentifiers

public String getCapabilityIdentifiers(String handle)
                                throws 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:
IOException - if the service can't be reached

getCapabilityIdentifiers

public String getCapabilityIdentifiers(String format,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

getOrgGroupIdentifiers

public String getOrgGroupIdentifiers(String handle)
                              throws 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:
IOException - if the service can't be reached

getOrgGroupIdentifiers

public String getOrgGroupIdentifiers(String format,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

getUserPrivileges

public String getUserPrivileges(String id,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

getNonHumanCategory

public String getNonHumanCategory(String id,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

getNonHumanCategoryByName

public String getNonHumanCategoryByName(String name,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

getNonHumanCategories

public String getNonHumanCategories(String handle)
                             throws 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:
IOException - if the service can't be reached

getNonHumanCategories

public String getNonHumanCategories(String format,
                                    String handle)
                             throws 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:
IOException - if the service can't be reached

getNonHumanSubCategories

public String getNonHumanSubCategories(String id,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

getNonHumanSubCategories

public String getNonHumanSubCategories(String id,
                                       String format,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

getNonHumanSubCategoriesByName

public String getNonHumanSubCategoriesByName(String category,
                                             String handle)
                                      throws 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:
IOException - if the service can't be reached

getNonHumanSubCategoriesByName

public String getNonHumanSubCategoriesByName(String category,
                                             String format,
                                             String handle)
                                      throws 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:
IOException - if the service can't be reached

getNonHumanCategorySet

public String getNonHumanCategorySet(String handle)
                              throws 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:
IOException - if the service can't be reached

validateUserCredentials

public String validateUserCredentials(String userid,
                                      String password,
                                      boolean checkForAdmin,
                                      String handle)
                               throws 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:
IOException - if the service can't be reached

getCodelets

public String getCodelets(String handle)
                   throws 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:
IOException - if the service can't be reached

getCodeletParameters

public String getCodeletParameters(String codeletName,
                                   String handle)
                            throws 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:
IOException - if the service can't be reached

getReferencedParticipantIDs

public String getReferencedParticipantIDs(String anyID,
                                          String handle)
                                   throws 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:
IOException - if the service can't be reached

isKnownParticipant

public String isKnownParticipant(String participantID,
                                 String handle)
                          throws 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:
IOException - if the service can't be reached

isKnownRole

public String isKnownRole(String roleID,
                          String handle)
                   throws 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:
IOException - if the service can't be reached

isKnownCapability

public String isKnownCapability(String capabilityID,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

isKnownPosition

public String isKnownPosition(String positionID,
                              String handle)
                       throws 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:
IOException - if the service can't be reached

isKnownOrgGroup

public String isKnownOrgGroup(String orgGroupID,
                              String handle)
                       throws 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:
IOException - if the service can't be reached

isKnownNonHumanResource

public String isKnownNonHumanResource(String id,
                                      String handle)
                               throws 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:
IOException - if the service can't be reached

isKnownNonHumanCategory

public String isKnownNonHumanCategory(String id,
                                      String handle)
                               throws 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:
IOException - if the service can't be reached

connect

public String connect(String userID,
                      String password)
               throws 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:
IOException - if the service can't be reached

checkConnection

public String checkConnection(String handle)
                       throws 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:
IOException - if the service can't be reached

disconnect

public void disconnect(String handle)
                throws IOException
Disconnects an external entity from the resource service

Parameters:
handle - the sessionHandle to disconnect
Throws:
IOException - if the service can't be reached

addParticipant

public String addParticipant(String userid,
                             String password,
                             boolean encrypt,
                             String lastname,
                             String firstname,
                             boolean admin,
                             String description,
                             String notes,
                             String handle)
                      throws 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:
IOException - if the service can't be reached

addNonHumanResource

public String addNonHumanResource(String name,
                                  String category,
                                  String subcategory,
                                  String description,
                                  String notes,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

addCapability

public String addCapability(String name,
                            String description,
                            String notes,
                            String handle)
                     throws 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:
IOException - if the service can't be reached

addRole

public String addRole(String name,
                      String description,
                      String notes,
                      String containingRoleID,
                      String handle)
               throws 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:
IOException - if the service can't be reached

addPosition

public String addPosition(String name,
                          String positionID,
                          String description,
                          String notes,
                          String orgGroupID,
                          String containingPositionID,
                          String handle)
                   throws 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:
IOException - if the service can't be reached

addOrgGroup

public String addOrgGroup(String name,
                          String groupType,
                          String description,
                          String notes,
                          String containingGroupID,
                          String handle)
                   throws 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:
IOException - if the service can't be reached

addParticipantToRole

public String addParticipantToRole(String participantID,
                                   String roleID,
                                   String handle)
                            throws 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:
IOException - if the service can't be reached

addParticipantToCapability

public String addParticipantToCapability(String participantID,
                                         String capabilityID,
                                         String handle)
                                  throws 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:
IOException - if the service can't be reached

addParticipantToPosition

public String addParticipantToPosition(String participantID,
                                       String positionID,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

addNonHumanCategory

public String addNonHumanCategory(String category,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

addNonHumanSubCategoryByName

public String addNonHumanSubCategoryByName(String category,
                                           String subcategory,
                                           String handle)
                                    throws 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:
IOException - if the service can't be reached

addNonHumanSubCategory

public String addNonHumanSubCategory(String id,
                                     String subcategory,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

updateParticipant

public String updateParticipant(String participantID,
                                String userid,
                                String password,
                                boolean encrypt,
                                String lastname,
                                String firstname,
                                boolean admin,
                                String description,
                                String notes,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

updateNonHumanResource

public String updateNonHumanResource(String resourceID,
                                     String name,
                                     String category,
                                     String subcategory,
                                     String description,
                                     String notes,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

updateCapability

public String updateCapability(String capabilityID,
                               String name,
                               String description,
                               String notes,
                               String handle)
                        throws 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:
IOException - if the service can't be reached

updateRole

public String updateRole(String roleID,
                         String name,
                         String description,
                         String notes,
                         String containingRoleID,
                         String handle)
                  throws 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:
IOException - if the service can't be reached

updatePosition

public String updatePosition(String posID,
                             String name,
                             String positionID,
                             String description,
                             String notes,
                             String orgGroupID,
                             String containingPositionID,
                             String handle)
                      throws 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:
IOException - if the service can't be reached

updateOrgGroup

public String updateOrgGroup(String groupID,
                             String name,
                             String groupType,
                             String description,
                             String notes,
                             String containingGroupID,
                             String handle)
                      throws 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:
IOException - if the service can't be reached

updateNonHumanCategory

public String updateNonHumanCategory(String categoryID,
                                     String name,
                                     String description,
                                     String notes,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

removeParticipant

public String removeParticipant(String participantID,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

removeNonHumanResource

public String removeNonHumanResource(String resourceID,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

removeCapability

public String removeCapability(String capabilityID,
                               String handle)
                        throws 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:
IOException - if the service can't be reached

removeRole

public String removeRole(String roleID,
                         String handle)
                  throws 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:
IOException - if the service can't be reached

removePosition

public String removePosition(String positionID,
                             String handle)
                      throws 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:
IOException - if the service can't be reached

removeOrgGroup

public String removeOrgGroup(String groupID,
                             String handle)
                      throws 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:
IOException - if the service can't be reached

removeParticipantFromRole

public String removeParticipantFromRole(String participantID,
                                        String roleID,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

removeParticipantFromCapability

public String removeParticipantFromCapability(String participantID,
                                              String capabilityID,
                                              String handle)
                                       throws 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:
IOException - if the service can't be reached

removeParticipantFromPosition

public String removeParticipantFromPosition(String participantID,
                                            String positionID,
                                            String handle)
                                     throws 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:
IOException - if the service can't be reached

removeNonHumanCategory

public String removeNonHumanCategory(String id,
                                     String handle)
                              throws 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:
IOException - if the service can't be reached

removeNonHumanCategoryByName

public String removeNonHumanCategoryByName(String category,
                                           String handle)
                                    throws 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:
IOException - if the service can't be reached

removeNonHumanSubCategoryByName

public String removeNonHumanSubCategoryByName(String category,
                                              String subcategory,
                                              String handle)
                                       throws 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:
IOException - if the service can't be reached

removeNonHumanSubCategory

public String removeNonHumanSubCategory(String id,
                                        String subcategory,
                                        String handle)
                                 throws 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:
IOException - if the service can't be reached

setContainingRole

public String setContainingRole(String roleID,
                                String containingRoleID,
                                String handle)
                         throws 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:
IOException - if the service can't be reached

setContainingOrgGroup

public String setContainingOrgGroup(String groupID,
                                    String containingGroupID,
                                    String handle)
                             throws 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:
IOException - if the service can't be reached

setContainingPosition

public String setContainingPosition(String positionID,
                                    String containingPositionID,
                                    String handle)
                             throws 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:
IOException - if the service can't be reached

setPositionOrgGroup

public String setPositionOrgGroup(String positionID,
                                  String groupID,
                                  String handle)
                           throws 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:
IOException - if the service can't be reached

setParticipantPrivileges

public String setParticipantPrivileges(String participantID,
                                       boolean canChooseItemToStart,
                                       boolean canStartConcurrent,
                                       boolean canReorder,
                                       boolean canViewTeamItems,
                                       boolean canViewOrgGroupItems,
                                       boolean canChainExecution,
                                       boolean canManageCases,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

setParticipantPrivileges

public String setParticipantPrivileges(String participantID,
                                       String bits,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

setParticipantPrivileges

public String setParticipantPrivileges(String participantID,
                                       boolean carteblanche,
                                       String handle)
                                throws 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:
IOException - if the service can't be reached

refreshOrgDataSet

public void refreshOrgDataSet(String handle)
                       throws IOException
Triggers a reload of org data

Parameters:
handle - a valid session handle with admin access
Throws:
IOException - if the service can't be reached

resetOrgDataRefreshRate

public void resetOrgDataRefreshRate(int minutes,
                                    String handle)
                             throws 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:
IOException - if the service can't be reached


Copyright © 2004-2012 The YAWL Foundation.