|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcRequestOperationsIntf
Method Summary | |
---|---|
void |
addAdministrativeGroup(long plRequestKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Adds an Administrative group to a request. |
void |
addRequestComment(long plRequestKey, java.lang.String psComment, java.lang.String psCommentType) Adds a user comment to a Request. |
long |
addRequestObject(long plRequestKey, long plObjectKey) Deprecated. |
long |
addRequestObject(long plRequestKey, long plObjectKey, boolean pbServiceAccount) Adds an Object to be provisioned to a Request |
long[] |
addRequestObjects(long plRequestKey, long[] plObjectKeys) Adds all Objects to be provisioned to a Request. |
void |
addRequestOrganization(long plRequestKey, long plOrganizationKey) Adds to a Request an Organization to be provisioned for. |
void |
addRequestUser(long plRequestKey, long plUserKey) Adds to a Request a User to be provisioned for. |
void |
assignQueue(long plQueueKey, long plRequestKey) Assigns a queue to a request |
void |
assignRequestObjectToQueue(long plQueueKey, long plRequestKey, long plObjectInstanceKey) Assigns a Request Object to a particular queue |
void |
assignRequestObjectToQueueAdmin(long plUserKey, long plRequestKey, long plObjectInstanceKey) Assigns a Request Object to a particular Queue Admin |
void |
assignRequestToUser(long plRequestKey, long plUserKey) Assigns an Administrator to a request. |
void |
cancelRequest(long plRequestKey) Cancels a request made in the system. |
void |
cancelRequest(java.lang.String plRequestId) Cancels a request made in the system by the request Id. |
boolean |
canTriggerObject(long plUserKey, long plObjectInstanceKey) Checks to see if the object being provisioned for a request can be triggered. |
void |
closeRequest(long plRequestKey) Closes a request made in the system. |
void |
completeRequestCreation(long plRequestKey) Completes the creation of a request, signifying that all the objects and targets for the request have been specified, and it should try to invoke the appropriate standard approval process. |
java.lang.String |
createProfileModifyRequest(java.util.Map attrs) Creates a user profile modification request. |
long |
createRequest(java.util.Map phAttributeList) Creates a request. |
void |
deselectInstancesForOrganization(long plRequestKey, long[] palObjectInstanceForOrganizationKeys) Allows the requester to deselect the specific instances of objects provisioned to an organization that must be acted upon as part of the request. |
void |
deselectInstancesForUser(long plRequestKey, long[] palObjectInstanceForUserKeys) Allows the requester to deselect the specific instances of objects provisioned to a user that must be acted upon as part of the request. |
Thor.API.tcResultSet |
findObjects(java.lang.String actionType, java.lang.String[] targetKeys, java.lang.String type, java.util.Map searchCriteria) This method returns all Resource Objects based on the parameters. |
Thor.API.tcResultSet |
findObjects(java.lang.String actionType, java.lang.String[] targetKeys, java.lang.String type, java.lang.String[] statusesIn, java.lang.String[] statusesNotIn, java.util.Map searchCriteria) This method returns all Resource Objects based on the parameters. |
Thor.API.tcResultSet |
findRequests(long[] requests) Find information about given request collection. |
Thor.API.tcResultSet |
findRequests(java.util.Map phAttributeList) Returns a list of requests that match the provided attribute list. |
Thor.API.tcResultSet |
findRequests(java.util.Map phAttributeList, java.util.Date startDate, java.util.Date endDate) Returns a list of requests that match the provided attribute list. |
Thor.API.tcResultSet |
findRequests(java.util.Map phAttributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Returns a list of requests that match the provided attribute list. |
Thor.API.tcResultSet |
findRequests(java.util.Map phAttributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, java.util.Date startDate, java.util.Date endDate) Returns a list of requests that match the provided attribute list. |
Thor.API.tcResultSet |
findRequestsAfterDate(java.util.Date pdStartDate) Returns a list of requests (in the form of a tcResultSet) that were made after the specified date |
Thor.API.tcResultSet |
findRequestsBeforeDate(java.util.Date pdEndDate) Returns a list of requests (in the form of a tcResultSet) that were made before the specified time |
Thor.API.tcResultSet |
findRequestsByDate(java.util.Date pdStartDate, java.util.Date pdEndDate) Returns a list of requests (in the form of a tcResultSet) that were made between the specified times |
Thor.API.tcResultSet |
findRequestsByStatusAfterDate(java.lang.String[] pasStatus, java.util.Date pdStartDate) Returns a list of requests (in the form of a tcResultSet) whose status was the specified value after the specified date |
Thor.API.tcResultSet |
findRequestsByStatusBeforeDate(java.lang.String[] pasStatus, java.util.Date pdEndDate) Returns a list of requests (in the form of a tcResultSet) whose status was the specified value before the specified time |
Thor.API.tcResultSet |
findRequestsByStatusDate(java.lang.String[] pasStatus, java.util.Date pdStartDate, java.util.Date pdEndDate) Returns a list of requests (in the form of a tcResultSet) whose status was the specified value between the specified times |
Thor.API.tcResultSet |
getApprovalTasksAssigned(java.util.Map attributeList) This method returns a list of all the pending approval tasks that are assigned to the specified user. |
Thor.API.tcResultSet |
getApprovalTasksAssignedToManagedUsers(long userKey, java.util.Map attributeList) This method behaves similar to getApprovalTasksAssignedToUser except for the fact that this method returns only the tasks assigned to the users managed by the user passed into this method, represented by userKey. |
Thor.API.tcResultSet |
getApprovalTasksAssignedToSubgroups(long userKey, java.util.Map attributeMap, boolean hierarchyOrder) This method returns a list of all the pending approval tasks that are visible to the specified user based on his indirect group membership. |
Thor.API.tcResultSet |
getApprovalTasksAssignedToUser(long userKey, java.util.Map attributeList) This method returns a list of all the pending approval tasks that are assigned to the specified user. |
int |
getCountOfPendingApprovalTasksAssignedToUser(long userKey, java.util.Map attributeList) This method returns a number of pending approval tasks that are assigned to the specified user. |
Thor.API.tcResultSet |
getGenericFindRequest(java.util.Map searchCriteria) Returns a list of requests (in the form of a tcResultSet) made for the specified user. |
Thor.API.tcResultSet |
getInstanceResolutionListForOrg(long plRequestKey, long plOrganizationKey, long plObjectKey) Returns a list of all the request objects - target organizations in the request that require the requester to select an existing instance of that object for that organization. |
Thor.API.tcResultSet |
getInstanceResolutionListForUser(long plRequestKey, long plUserKey, long plObjectKey) Returns a list of all the request objects - target users in the request that require the requester to select an existing instance of that object for that user. |
Thor.API.tcResultSet |
getInstanceResolutionOptionsForOrg(long plRequestKey, long plOrganizationKey, long plObjectKey) Returns a list of all the object instances of the specified object currently provisioned to the specified organization in the request that are valid options for instance resolution. |
Thor.API.tcResultSet |
getInstanceResolutionOptionsForUser(long plRequestKey, long plUserKey, long plObjectKey) Returns a list of all the object instances of the specified object that are currently provisioned to the specified user in the request and are valid options for instance resolution. |
int |
getNumberOfApprovalTasksAssignedToUser(long userKey, java.lang.String[] statuses) This method returns the number of approval tasks are assigned to a given user, to any users that this user is a proxy of, and to any groups that this user member of based on the given statuses. |
int |
getNumberOfPendingApprovalTasksAssignedToUser(long userKey) This method returns the number of approval tasks are assigned to a given user, to any users that this user is a proxy of, and to any groups that this user member of based on the given statuses.This uses OTI table which has a subset of data present in OSI/SCH table |
long |
getNumberOfPendingRequests(long userKey) Returns the number of pending requests given a user key |
long |
getNumberOfPendingRequestsAssignedToUser(long userKey) Returns the number of pending requests given a user key This uses OTI table which has a subset of data present in OSI/SCH table |
int |
getNumberOfRequestsCreatedByUser(long userKey, boolean pending) Returns the number of requests that have been created by a specific user. |
int |
getNumberOfRequestsCreatedByUser(java.util.Map phAttributeMap) Returns the number of requests that have been created by a specific user. |
int |
getNumberOfRequestsCreatedForUser(long userKey, boolean pending) Returns the number of requests that have been created for a specific user. |
int |
getNumberOfRequestsForTargetUser(long userKey) Returns the number of Requests raised for a given user. |
Thor.API.tcResultSet |
getPendingApprovals(long requestID) Deprecated. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssigned(java.util.Map attributeList) This method returns a list of all the pending approval tasks that are assigned to the specified user. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssignedToManagedUsers(long userKey, java.util.Map attributeList) This method behaves similar to getApprovalTasksAssignedToUser except for the fact that this method returns only the tasks assigned to the users managed by the user passed into this method, represented by userKey. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssignedToManagedUsersPaged(long userKey, java.util.Map attributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, boolean getTotalRowCount) This method returns a list of all the pending approval tasks that are assigned to the users managed by a specific user. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssignedToSubgroups(long userKey, java.util.Map attributeMap, boolean hierarchyOrder) This method returns a list of all the pending approval tasks that are visible to the specified user based on his indirect group membership. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssignedToSubgroupsPaged(long userKey, java.util.Map attributeMap, boolean hierarchyOrder, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, boolean getTotalRowCount) This method returns a list of all the pending approval tasks that are visible to the specified user based on his indirect group membership. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssignedToUser(long userKey, java.util.Map attributeList) This method returns a list of all the pending approval tasks that are assigned to the specified user. |
Thor.API.tcResultSet |
getPendingApprovalTasksAssignedToUserPaged(long userKey, java.util.Map attributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, boolean getTotalRowCount) This method returns a list of all the pending approval tasks that are assigned to the specified user. |
Thor.API.tcResultSet |
getProvisioningDetail(long requestID) This method returns all provisioning information for the reqeust. |
Thor.API.tcResultSet |
getQueuesForRequest(long plRequestKey) Returns a list of queues (in the form of a tcResultSet) for the specified request. |
Thor.API.tcResultSet |
getRegistrationUserDetails(long reqKey) This returns the request data associated with the given request. |
Thor.API.tcResultSet |
getRequestAdministrativeGroups(long plRequestKey) Retrieves all the administrative groups for a request. |
Thor.API.tcResultSet |
getRequestComments(long plRequestKey, java.lang.String psCommentType) Retrieves all the comments for a request. |
com.thortech.xl.vo.RequestDetail |
getRequestDetail(java.lang.String requestKey, java.lang.String requestID) Returns all the request detail by request key |
java.lang.String[][] |
getRequestHistory(java.lang.String reqID) Gets the history of the request since its submission. |
Thor.API.tcResultSet |
getRequestObjects(long plRequestKey) Retrieves all the objects being requested |
Thor.API.tcResultSet |
getRequestObjectStatusHistory(long plRequestKey, long plObjectInstanceKey) Retrieves the status history of the specified request object |
Thor.API.tcResultSet |
getRequestObjectTargetInstanceKeys(long plRequestKey, long plObjectInstanceKey) Retrieves the object instance keys for targets for the specified request and request object instance. |
java.lang.String[] |
getRequestResponses(long plRequestKey, long plUserKey) Returns the responses that the specified user can set for the specified request. |
java.lang.String[] |
getRequestRoles(long plRequestKey, long plUserKey) Returns the roles that the specified user plays in the specified request. |
Thor.API.tcResultSet |
getRequestsAssignedForApproval(long plUserKey, java.lang.String[] pasStatus, boolean pbUserPending) Searches for all the requests that have an approval process in which one of the approval tasks is assigned to the specified user. |
Thor.API.tcResultSet |
getRequestsAssignedForApproval(long plUserKey, java.lang.String[] pasStatus, boolean pbUserPending, java.util.Date pdEndDate) Searches for all requests that have an approval process in which one of the approval tasks is assigned to the specified user or to a group that the user is a member of. |
Thor.API.tcResultSet |
getRequestsAssignedForApproval(long userKey, java.lang.String[] status, boolean userPending, java.util.Date endDate, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Returns a list of requests (in the form of a tcResultSet) that are assigned to the given user for approval. |
Thor.API.tcResultSet |
getRequestsForAuthorization(long plUserKey, java.lang.String[] pasStatus, boolean pbUserPending) Returns all the requests that the given user is authorized to approve. |
Thor.API.tcResultSet |
getRequestsForObject(java.lang.String psObjectName, java.lang.String[] pasStatus) Returns a list of requests (in the form of a tcResultSet) for the specified object. |
Thor.API.tcResultSet |
getRequestsForOrganizationTarget(long plOrganizationKey, java.lang.String[] pasStatus) Returns a list of requests (in the form of a tcResultSet) made for the specified organization. |
Thor.API.tcResultSet |
getRequestsForQueue(long plQueueKey) Returns a list of requests (in the form of a tcResultSet) for the specified queue. |
Thor.API.tcResultSet |
getRequestsForQueueByStatus(long plQueueKey, java.lang.String[] pasStatus) Returns a list of requests (in the form of a tcResultSet) which have the given status for the specified queue. |
Thor.API.tcResultSet |
getRequestsForUserTarget(long plUserKey, java.lang.String[] pasStatus, java.util.Date pdEndDate) Returns a list of requests (in the form of a tcResultSet) made for the specified user. |
Thor.API.tcResultSet |
getRequestsForUserTarget(long plUserKey, java.lang.String[] pasStatus, java.util.Map attributeList) Returns a list of requests (in the form of a tcResultSet) made for the specified user. |
Thor.API.tcResultSet |
getRequestsForUserTarget(long plUserKey, java.lang.String[] pasStatus, java.util.Map attributeList, java.util.Date startDate, java.util.Date endDate) Returns a list of requests (in the form of a tcResultSet) made for the specified user. |
java.lang.String[][] |
getRequestStages(long plRequestKey) Returns all the stages identified for the specified request, and what status each stage is in. |
Thor.API.tcResultSet |
getRequestStatusHistory(long plRequestKey) Retrieves the status history of the request. |
Thor.API.tcResultSet |
getRequestTargets(long plRequestKey) Retrieves all the targets (users or organizations) for whom the request is being made. |
Thor.API.tcResultSet |
getRequestTargetsForAdditionalFeilds(long plRequestKey, java.util.List feilds) Retrieves all the targets (users or organizations) for whom the request is being made. |
java.lang.String[] |
getRequestTypes() Returns all the request types defined in the Xellerate system. |
Thor.API.tcResultSet |
getSelectedInstancesForOrg(long plRequestKey, long plOrganizationKey, long plObjectKey) Returns a list of all the object instances that are currently provisioned to the specified organization in the request and match the specified object in the request that have been selected for the request action. |
Thor.API.tcResultSet |
getSelectedInstancesForUser(long plRequestKey, long plUserKey, long plObjectKey) Returns a list of all the object instances that are currently provisioned to the specified user in the request and match the specified object in the request that have been selected for the request action. |
Thor.API.tcResultSet |
getSelectedResolutionInstances(java.lang.String requestKey, java.lang.String type) Returns a list of all the object instances that are currently provisioned to the users/organizations in the request and match the specified object in the request that have been selected for the request action. |
void |
initiateRequestApproval(long reqKey) Initiates the request approval(Standard Approval) process |
boolean |
isRequestApprovable(long plRequestKey, long plUserKey) Returns whether the specified user has the authority to approve the specified request. |
boolean |
isRequestCancellable(long plRequestKey, long plUserKey) Returns whether the specified user has the authority to cancel the specified request. |
boolean |
isRequestUpdatable(long plRequestKey, long plUserKey) Returns whether the specified user has the authority to update the specified request. |
boolean |
isResourceApprovable(long plObjectInstanceKey, long plUserKey) Checks wheather the resource can be approved by this user |
boolean |
isUserSelfRegistrationChallengeValuesProvided(long psRequestKey) Checks if user self registration challenge question and answers have been provided |
void |
reassignApprovalTasksToGroup(long[] taskInstanceKeys, long groupKey) This method re-assigns the selected approval tasks to the specified group. |
void |
reassignApprovalTasksToUser(long[] taskInstanceKeys, long userKey) This method re-assigns the selected approval tasks to the specified user. |
void |
removeAdministrativeGroup(long plRequestKey, long plGroupKey) Remove an Administrative group from a request. |
void |
removeQueue(long plQueueKey, long plRequestKey) Removes a queue from a request |
void |
removeRequestObject(long plRequestKey, long plObjectKey) Deletes an Object to be provisioned from a Request |
void |
removeRequestObject(java.lang.String requestKey, java.lang.String objectInstanceKey) Deletes an Object to be provisioned from a Request |
void |
removeRequestObjectFromQueue(long plRequestKey, long plObjectInstanceKey) Removes a Request Object from its assigned queue |
void |
removeRequestOrganization(long plRequestKey, long plOrganizationKey) Removes from a Request an Organization to be provisioned for. |
void |
removeRequestUser(long plRequestKey, long plUserKey) Deletes from a Request a User to be provisioned for. |
void |
requestMoreInfoFromGroup(long plRequestKey, long plGroupKey) Initiates a request more info in the system for a specified request. |
void |
requestMoreInfoFromGroupWithComment(long plRequestKey, long plGroupKey, java.lang.String psComment) Initiates a request more info in the system for a specified request. |
void |
requestMoreInfoFromUser(long plRequestKey, long plUserKey) Initiates a request more info in the system for a specified request. |
void |
requestMoreInfoFromUserForResource(long plRequestKey, long plUserKey, long plObjectKey) Initiates a request more info in the system for a specified resource object of a request. |
void |
requestMoreInfoFromUserWithComment(long plRequestKey, long plUserKey, java.lang.String psComment) Initiates a request more info in the system for a specified request. |
void |
requestMoreInfoFromUserWithCommentForResource(long plRequestKey, long plUserKey, long plObjectKey, java.lang.String psComment) Initiates a request more info in the system for a specified resource object of a request. |
boolean |
requiresInstanceResolution(long plRequestKey) Indicates whether the specified request requires the requester to resolve object instance issues related to the objects in this request. |
void |
selectInstancesForOrganization(long plRequestKey, long[] palObjectInstanceForOrganizationKeys) Allows the requester to select the specific instances of objects provisioned to an organization that must be acted upon as part of the request. |
void |
selectInstancesForUser(long plRequestKey, long[] palObjectInstanceForUserKeys) Allows the requester to select the specific instances of objects provisioned to a user that must be acted upon as part of the request. |
void |
setRequestObjectAsServiceAccountFlag(long plRequestKey, long plObjectInstanceKey, boolean pbServiceAccount) Sets the flag on the requested object that indicates whether it is to be provisioned as a service account or not. |
void |
setRequestResponse(long plRequestKey, long plUserKey, java.lang.String psResponse) Sets the specified response from the specified user on all the tasks in the specified request that the user has access to. |
void |
setResourceResponse(long plUserKey, long plObjectInstanceKey, java.lang.String psResponse) Sets the specified response from the specified user on all the tasks in the specified resource object instance that the user has access to. |
void |
triggerRequestObject(long plRequestKey, long plObjectInstanceKey) Trigger execution of an Object being provisioned for a Request |
void |
updateAdministrativeGroup(long plRequestKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Update the access an Administrative group has to a request. |
void |
updateRegistrationUserDetails(long pnRequestKey, java.util.Map poAttributes) Updates the request's data with the values passed. |
void |
updateRegistrationUserDetails(long pnRequestKey, com.thortech.xl.orb.api.tcMapping[] poAttributes) Updates the request's data with the values passed. |
void |
updateRequest(long plRequestKey, java.util.Map phAttributeList) Updates the specified attributes of a request. |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
Thor.API.tcResultSet findRequests(java.util.Map phAttributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find requests. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
or an array of String
's representing the criteria to find the desired requests. If an array of String
's is used, there will be an OR relationship between each element of the array. Note that the Map
values can include wild cards(%).startRow
- the start row to retrieve the datapageSize
- the end row of the data to retrieveorder
- an array of string to sort the result dataascendingOrder
- if the order should be in ascending or descending ordertcResultSet
that contains any user-defined columns as well as the following Request-related information:
tcAPIException
Thor.API.tcResultSet findRequests(java.util.Map phAttributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, java.util.Date startDate, java.util.Date endDate) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find requests. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
or an array of String
's representing the criteria to find the desired requests. If an array of String
's is used, there will be an OR relationship between each element of the array. Note that the Map
values can include wild cards(%).startRow
- the start row to retrieve the datapageSize
- the end row of the data to retrieveorder
- an array of string to sort the result dataascendingOrder
- if the order should be in ascending or descending orderstartDate
- The date and time after which the request should have been created. If this parameter is null then a start date is not used in the search criteria.endDate
- The date and time before which the request should have been created. If this parameter is null then an end date is not used in the search criteria.tcResultSet
that contains any user-defined columns as well as the following Request-related information:
tcAPIException
Thor.API.tcResultSet findRequests(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find requests. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
or an array of String
's representing the criteria to find the desired requests. If an array of String
's is used, there will be an OR relationship between each element of the array. Note that the Map
values can include wild cards(%).tcResultSet
that contains any user-defined columns as well as the following Request-related information:
tcAPIException
Thor.API.tcResultSet findRequests(java.util.Map phAttributeList, java.util.Date startDate, java.util.Date endDate) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find requests. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
or an array of String
's representing the criteria to find the desired requests. If an array of String
's is used, there will be an OR relationship between each element of the array. Note that the Map
values can include wild cards(%).startDate
- The date and time after which the request should have been created. If this parameter is null then a start date is not used in the search criteria.endDate
- The date and time before which the request should have been created. If this parameter is null then an end date is not used in the search criteria.tcResultSet
that contains any user-defined columns as well as the following Request-related information:
tcAPIException
Thor.API.tcResultSet findRequests(long[] requests) throws tcAPIException, tcAPIException
IMPORTANT NOTE: This API uses the SQL IN cluse to look for all requests and can be slow if there are too many requests in the array.
tcAPIException
for more details on the result set returned.
Thor.API.tcResultSet findRequestsByDate(java.util.Date pdStartDate, java.util.Date pdEndDate) throws tcAPIException, tcAPIException
pdStartDate
- The long representation of the date and time after which the request should have been made.pdEndDate
- The long representation of the date and time before which the request should have been made.tcAPIException
Thor.API.tcResultSet findRequestsAfterDate(java.util.Date pdStartDate) throws tcAPIException, tcAPIException
pdStartDate
- The long representation of the date and time after which the request should have been made.tcAPIException
Thor.API.tcResultSet findRequestsBeforeDate(java.util.Date pdEndDate) throws tcAPIException, tcAPIException
pdEndDate
- The long representation of the date and time before which the request should have been made.tcAPIException
Thor.API.tcResultSet findRequestsByStatusDate(java.lang.String[] pasStatus, java.util.Date pdStartDate, java.util.Date pdEndDate) throws tcAPIException, tcAPIException
pasStatus
- An array
of statuses to filter the requests by. If multiple statuses are specified, they are evaluated using the OR operation.pdStartDate
- The long representation of the date and time after which the request should have had this statuspdEndDate
- The long representation of the date and time before which the request should have has this status.tcResultSet
that contains any user-defined columns as well as the following Request-related information:
tcAPIException
Thor.API.tcResultSet findRequestsByStatusAfterDate(java.lang.String[] pasStatus, java.util.Date pdStartDate) throws tcAPIException, tcAPIException
pasStatus
- The status to filter onpdStartDate
- The long representation of the date and time after which the request should have had the specified status.tcAPIException
Thor.API.tcResultSet findRequestsByStatusBeforeDate(java.lang.String[] pasStatus, java.util.Date pdEndDate) throws tcAPIException, tcAPIException
pasStatus
- The status to filter onpdEndDate
- The long representation of the date and time before which the request should have had the specified status.tcAPIException
Thor.API.tcResultSet getRequestsForObject(java.lang.String psObjectName, java.lang.String[] pasStatus) throws tcAPIException, tcObjectNotFoundException, tcAPIException
psObjectName
- The name of the object to search requests for.pasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.tcAPIException
tcObjectNotFoundException
Thor.API.tcResultSet getRequestsForUserTarget(long plUserKey, java.lang.String[] pasStatus, java.util.Date pdEndDate) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The User Key of the user for whom requests have been made.pasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.pdEndDate
- The date and time before which the request should have been made.tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getRequestsForUserTarget(long plUserKey, java.lang.String[] pasStatus, java.util.Map attributeList, java.util.Date startDate, java.util.Date endDate) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The User Key of the user for whom requests have been made.pasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.attributeList
- Search CriteriastartDate
- The date and time after which the request should have been created. If this parameter is null then a start date is not used in the search criteria.endDate
- The date and time before which the request should have been created. If this parameter is null then an end date is not used in the search criteria.tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getRequestsForUserTarget(long plUserKey, java.lang.String[] pasStatus, java.util.Map attributeList) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The User Key of the user for whom requests have been made.pasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.attributeList
- Search CriteriatcAPIException
tcUserNotFoundException
int getNumberOfRequestsCreatedByUser(java.util.Map phAttributeMap) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- The user key of the user who the requests are created by.tcUserNotFoundException
tcAPIException
int getNumberOfRequestsForTargetUser(long userKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
userKey
- The User Key of the user for whom requests have been raise for.tcAPIException
- raised if an exception is encounteredtcUserNotFoundException
- raised if the user key passed is not validThor.API.tcResultSet getRequestsForOrganizationTarget(long plOrganizationKey, java.lang.String[] pasStatus) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrganizationKey
- The Organization Key of the organization for whom requests have been made.pasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.tcAPIException
tcOrganizationNotFoundException
Thor.API.tcResultSet getRequestsAssignedForApproval(long userKey, java.lang.String[] status, boolean userPending, java.util.Date endDate, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) throws tcAPIException, tcUserNotFoundException, tcAPIException
userKey
- The User Key of the user who has to approve the requeststatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.userPending
- Boolean indicating whether to only display those requests that are pending approval by the specified user. True indicates only show those where the approval task assigned to the specified user is pending. False means show all without filteringendDate
- The date and time before which the request should have been made.startRow
- The starting row of the requests that match the given criteriapageSize
- is the number of records to return starting from startRoworder
- is a String array of order columns to sort the matching recordsascendingOrder
- is a boolean value referring if the order should be ascending (true) or descending (false).tcAPIException
- general exception if there is a problem processing the require datatcUserNotFoundException
- if the userKey given is not found in the databaseThor.API.tcResultSet getRequestsAssignedForApproval(long plUserKey, java.lang.String[] pasStatus, boolean pbUserPending, java.util.Date pdEndDate) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The User Key of the user who has to approve the requestpasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.pbUserPending
- Boolean indicating whether to only display those requests that are pending approval by the specified user. True indicates only show those where the approval task assigned to the specified user is pending. False means show all without filteringpdEndDate
- The date and time before which the request should have been made.tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getRequestsAssignedForApproval(long plUserKey, java.lang.String[] pasStatus, boolean pbUserPending) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The User Key of the user who has to approve the requestpasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.pbUserPending
- Boolean indicating whether to only display those requests that are pending approval by the specified user. True indicates only show those where the approval task assigned to the specified user is pending. False means show all without filteringtcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getRequestTargetsForAdditionalFeilds(long plRequestKey, java.util.List feilds) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The Request Key of the request to get the targets forfeilds
- The additianal feilds which needs to be displayed in request details.tcAPIException
tcRequestNotFoundException
Thor.API.tcResultSet getRequestTargets(long plRequestKey) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The Request Key of the request to get the targets fortcAPIException
tcRequestNotFoundException
Thor.API.tcResultSet getRequestObjects(long plRequestKey) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The Request Key of the request to get the objects fortcAPIException
tcRequestNotFoundException
boolean isResourceApprovable(long plObjectInstanceKey, long plUserKey) throws tcAPIException, tcAPIException
plObjectInstanceKey
- Resource instanceplUserKey
- User KeytcAPIException
Thor.API.tcResultSet getRequestComments(long plRequestKey, java.lang.String psCommentType) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The key of the request to get comments forpsCommentType
- The type of comment to retrieve. Its value is based on LKU where code = "Request Comments.Type". Leave null or blank if all comments are to be retrieved.tcResultSet
that contains the following information about the specified request's comments:
tcAPIException
tcRequestNotFoundException
Thor.API.tcResultSet getRequestAdministrativeGroups(long plRequestKey) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The Request Key of the request to get the administrative groups fortcAPIException
tcRequestNotFoundException
Thor.API.tcResultSet getRequestStatusHistory(long plRequestKey) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The key of the request to get the status history fortcResultSet
that contains the following information about the request status history:
tcAPIException
tcRequestNotFoundException
Thor.API.tcResultSet getRequestObjectStatusHistory(long plRequestKey, long plObjectInstanceKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The key of the request to get the status history forplObjectInstanceKey
- The key of the object instancetcResultSet
that contains the following information about the request status history:
tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
Thor.API.tcResultSet getRequestObjectTargetInstanceKeys(long plRequestKey, long plObjectInstanceKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The Request Key of the request to get the objects forplObjectInstanceKey
- The key of the object instancetcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
java.lang.String createProfileModifyRequest(java.util.Map attrs) throws tcRequiredDataMissingException, tcAPIException, tcOrganizationNotFoundException, tcInvalidManagerException, tcDuplicateUserException, com.thortech.xl.orb.dataaccess.tcDataAccessException, tcAPIException
attrs
- AMap
of name-value pairs, representing the user profile information being modified.tcRequiredDataMissingException
tcAPIException
tcOrganizationNotFoundException
tcInvalidManagerException
tcDuplicateUserException
com.thortech.xl.orb.dataaccess.tcDataAccessException
long createRequest(java.util.Map phAttributeList) throws tcAttributeMissingException, tcInvalidAttributeException, tcRequestInvalidException, tcAPIException, tcAPIException
phAttributeList
- A map of name-value pairs, each entry representing an attribute to be set for the request.tcAttributeMissingException
tcInvalidAttributeException
tcRequestInvalidException
tcAPIException
void completeRequestCreation(long plRequestKey) throws tcAPIException, tcRequestInvalidException, tcAPIException
plRequestKey
- The key for the request to update.tcAPIException
tcRequestInvalidException
void updateRequest(long plRequestKey, java.util.Map phAttributeList) throws tcAPIException, tcRequestInvalidException, tcInvalidUpdateException, tcAPIException
plRequestKey
- The key for the request to update.phAttributeList
- The list of attribute-value pairs being updatedtcAPIException
tcRequestInvalidException
tcInvalidUpdateException
void cancelRequest(long plRequestKey) throws tcAPIException, tcRequestInvalidException, tcAPIException
plRequestKey
- The key for the request to cancel.tcAPIException
tcRequestInvalidException
void cancelRequest(java.lang.String plRequestId) throws tcAPIException, tcRequestInvalidException, tcAPIException
plRequestId
- The Id for the request to cancel.tcAPIException
tcRequestInvalidException
void closeRequest(long plRequestKey) throws tcAPIException, tcRequestInvalidException, tcAPIException
plRequestKey
- The key for the request to close.tcAPIException
tcRequestInvalidException
long[] addRequestObjects(long plRequestKey, long[] plObjectKeys) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The key for the request to add the object to.plObjectKeys
- The long array of Object keys to add.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
long addRequestObject(long plRequestKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The key for the request to add the object to.plObjectKey
- The key of the Object to addtcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestOperationsIntf.addRequestObjects(long plRequestKey, long[] plObjectKeys)
long addRequestObject(long plRequestKey, long plObjectKey, boolean pbServiceAccount) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The key for the request to add the object to.plObjectKey
- The key of the Object to addpbServiceAccount
- Whether the resource should be provisioned as a service account or not (True for yes)tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
void setRequestObjectAsServiceAccountFlag(long plRequestKey, long plObjectInstanceKey, boolean pbServiceAccount) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The key for the request to update the object for.plObjectInstanceKey
- The key of the Object Instance within the request (as retrieved from the @see getRequestObjects method)pbServiceAccount
- Whether the resource should be provisioned as a service account or not (True for yes)tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
void removeRequestObject(long plRequestKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
plRequestKey
- The key for the request to remove the object from.plObjectKey
- The key of the Object to removetcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
boolean canTriggerObject(long plUserKey, long plObjectInstanceKey) throws tcAPIException, tcUserNotFoundException, tcRequestObjectInvalidException, tcObjectNotApprovedException, tcAPIException
plUserKey
- The key of the userplObjectInstanceKey
- The key of the object instancetcAPIException
tcUserNotFoundException
tcRequestObjectInvalidException
tcObjectNotApprovedException
void triggerRequestObject(long plRequestKey, long plObjectInstanceKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcObjectNotApprovedException, tcAPIException
plRequestKey
- The key for the request to trigger the object forplObjectInstanceKey
- The key of the object instancetcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcObjectNotApprovedException
void addRequestUser(long plRequestKey, long plUserKey) throws tcAPIException, tcRequestNotFoundException, tcRequestUserInvalidException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User to add as a target for the requesttcAPIException
tcRequestNotFoundException
tcRequestUserInvalidException
void removeRequestUser(long plRequestKey, long plUserKey) throws tcAPIException, tcRequestNotFoundException, tcRequestUserInvalidException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User to remove as a target for the requesttcAPIException
tcRequestNotFoundException
tcRequestUserInvalidException
void addRequestOrganization(long plRequestKey, long plOrganizationKey) throws tcAPIException, tcRequestNotFoundException, tcRequestOrganizationInvalidException, tcAPIException
plRequestKey
- The key for the Request.plOrganizationKey
- The key of the Organization to add as a target for the requesttcAPIException
tcRequestNotFoundException
tcRequestOrganizationInvalidException
void removeRequestOrganization(long plRequestKey, long plOrganizationKey) throws tcAPIException, tcRequestNotFoundException, tcRequestOrganizationInvalidException, tcAPIException
plRequestKey
- The key for the Request.plOrganizationKey
- The key of the Organization to remove as a target for the requesttcAPIException
tcRequestNotFoundException
tcRequestOrganizationInvalidException
void addRequestComment(long plRequestKey, java.lang.String psComment, java.lang.String psCommentType) throws tcAPIException, tcRequestNotFoundException, tcRequestCommentInvalidException, tcAPIException
plRequestKey
- The key for the Request.psComment
- The comment to add to the requestpsCommentType
- The type of comment being added. Its value is based on LKU where code = Lookup.Request Comments.TypetcAPIException
tcRequestNotFoundException
tcRequestCommentInvalidException
void addAdministrativeGroup(long plRequestKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcGroupNotFoundException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The key for the Request.plGroupKey
- The key of the Group to add as an administrator for the requestpbWrite
- Whether the group has write access to the grouppbDelete
- Whether the group has delete access to the grouptcAPIException
tcGroupNotFoundException
tcRequestNotFoundException
void updateAdministrativeGroup(long plRequestKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcAdminNotFoundException, tcGroupNotFoundException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The key for the Request.plGroupKey
- The key of the Group to update the permissions forpbWrite
- Whether the group has write access to the grouppbDelete
- Whether the group has delete access to the grouptcAPIException
tcAdminNotFoundException
tcGroupNotFoundException
tcRequestNotFoundException
void removeAdministrativeGroup(long plRequestKey, long plGroupKey) throws tcAPIException, tcAdminNotFoundException, tcGroupNotFoundException, tcRequestNotFoundException, tcRequestGroupInvalidException, tcAPIException
plRequestKey
- The key for the Request.plGroupKey
- The key of the Group to remove as an administrator for the requesttcAPIException
tcAdminNotFoundException
tcGroupNotFoundException
tcRequestNotFoundException
tcRequestGroupInvalidException
void assignRequestToUser(long plRequestKey, long plUserKey) throws tcAdministratorAlreadyAssignedException, tcAPIException, tcInvalidUserException, tcRequestNotFoundException, tcUserNotFoundException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User to assign as an administratortcAdministratorAlreadyAssignedException
tcAPIException
tcInvalidUserException
tcRequestNotFoundException
tcUserNotFoundException
boolean isRequestCancellable(long plRequestKey, long plUserKey) throws tcAPIException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User whose privileges are to be checkedtcAPIException
boolean isRequestUpdatable(long plRequestKey, long plUserKey) throws tcAPIException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User whose privileges are to be checkedtcAPIException
boolean isRequestApprovable(long plRequestKey, long plUserKey) throws tcAPIException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User whose approval privileges are to be checkedtcAPIException
java.lang.String[] getRequestRoles(long plRequestKey, long plUserKey) throws tcAPIException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User whose request roles are to be checkedtcAPIException
java.lang.String[] getRequestResponses(long plRequestKey, long plUserKey) throws tcAPIException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User whose possible responses are to be checkedtcAPIException
void setRequestResponse(long plRequestKey, long plUserKey, java.lang.String psResponse) throws tcAPIException, tcInvalidResponseException, tcAwaitingObjectDataCompletionException, tcAwaitingApprovalDataCompletionException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User setting the responsepsResponse
- The response to set for the requesttcAPIException
tcInvalidResponseException
tcAwaitingObjectDataCompletionException
tcAwaitingApprovalDataCompletionException
void requestMoreInfoFromUser(long plRequestKey, long plUserKey) throws tcAPIException, tcInvalidResponseException, tcRequestApprovedException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User who must be notified to provide more information for this request.tcAPIException
tcInvalidResponseException
tcRequestApprovedException
void requestMoreInfoFromUserWithComment(long plRequestKey, long plUserKey, java.lang.String psComment) throws tcAPIException, tcInvalidResponseException, tcRequestApprovedException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User who must be notified to provide more information for this request.psComment
- The comment of the usertcAPIException
tcInvalidResponseException
tcRequestApprovedException
void requestMoreInfoFromUserForResource(long plRequestKey, long plUserKey, long plObjectKey) throws tcAPIException, tcInvalidResponseException, tcRequestApprovedException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User who must be notified to provide more information for this request.plObjectKey
- The key for the resource objecttcAPIException
tcInvalidResponseException
tcRequestApprovedException
void requestMoreInfoFromUserWithCommentForResource(long plRequestKey, long plUserKey, long plObjectKey, java.lang.String psComment) throws tcAPIException, tcInvalidResponseException, tcRequestApprovedException, tcAPIException
plRequestKey
- The key for the Request.plUserKey
- The key of the User who must be notified to provide more information for this request.plObjectKey
- The key for the resource objectpsComment
- The comment of the usertcAPIException
tcInvalidResponseException
tcRequestApprovedException
void requestMoreInfoFromGroup(long plRequestKey, long plGroupKey) throws tcAPIException, tcInvalidResponseException, tcRequestApprovedException, tcAPIException
plRequestKey
- The key for the Request.plGroupKey
- The key of the Group that must be notified to provide more information for this request.tcAPIException
tcInvalidResponseException
tcRequestApprovedException
void requestMoreInfoFromGroupWithComment(long plRequestKey, long plGroupKey, java.lang.String psComment) throws tcAPIException, tcInvalidResponseException, tcRequestApprovedException, tcAPIException
plRequestKey
- The key for the Request.plGroupKey
- The key of the Group that must be notified to provide more information for this request.psComment
- The comment related to the request for more information.tcAPIException
tcInvalidResponseException
tcRequestApprovedException
java.lang.String[] getRequestTypes() throws tcAPIException, tcAPIException
tcAPIException
java.lang.String[][] getRequestStages(long plRequestKey) throws tcAPIException, tcAPIException
plRequestKey
- The key for the Request.tcAPIException
Thor.API.tcResultSet getRequestsForQueue(long plQueueKey) throws tcQueueNotFoundException, tcAPIException, tcAPIException
plQueueKey
- The key for the Queue.tcQueueNotFoundException
tcAPIException
Thor.API.tcResultSet getRequestsForQueueByStatus(long plQueueKey, java.lang.String[] pasStatus) throws tcQueueNotFoundException, tcAPIException, tcAPIException
plQueueKey
- The key for the Queue.pasStatus
- The status of the requests which would be returnedtcQueueNotFoundException
tcAPIException
Thor.API.tcResultSet getQueuesForRequest(long plRequestKey) throws tcRequestNotFoundException, tcAPIException, tcAPIException
plRequestKey
- The key for the Request.tcRequestNotFoundException
tcAPIException
void assignQueue(long plQueueKey, long plRequestKey) throws tcRequestNotFoundException, tcQueueNotFoundException, tcAPIException, tcAPIException
plQueueKey
- The key for the Queue.plRequestKey
- The Key of the Request.tcRequestNotFoundException
tcQueueNotFoundException
tcAPIException
void removeQueue(long plQueueKey, long plRequestKey) throws tcRequestNotFoundException, tcQueueNotFoundException, tcAPIException, tcAPIException
plQueueKey
- The key for the Queue.plRequestKey
- The Key of the Request.tcRequestNotFoundException
tcQueueNotFoundException
tcAPIException
void assignRequestObjectToQueue(long plQueueKey, long plRequestKey, long plObjectInstanceKey) throws tcRequestNotFoundException, tcQueueNotFoundException, tcRequestObjectInvalidException, tcAPIException, tcAPIException
plQueueKey
- The key for the Queue.plRequestKey
- The Key of the Request.plObjectInstanceKey
- The Key of the Request Object Instance.tcRequestNotFoundException
tcQueueNotFoundException
tcRequestObjectInvalidException
tcAPIException
void removeRequestObjectFromQueue(long plRequestKey, long plObjectInstanceKey) throws tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException, tcAPIException
plRequestKey
- The Key of the Request.plObjectInstanceKey
- The Key of the Request Object Instance.tcRequestNotFoundException
tcRequestObjectInvalidException
tcAPIException
void assignRequestObjectToQueueAdmin(long plUserKey, long plRequestKey, long plObjectInstanceKey) throws tcRequestNotFoundException, tcUserNotFoundException, tcRequestObjectInvalidException, tcAPIException, tcAPIException
plUserKey
- The key for the User.plRequestKey
- The Key of the Request.plObjectInstanceKey
- The Key of the Request Object Instance.tcRequestNotFoundException
tcUserNotFoundException
tcRequestObjectInvalidException
tcAPIException
Thor.API.tcResultSet getRequestsForAuthorization(long plUserKey, java.lang.String[] pasStatus, boolean pbUserPending) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The User Key of the user who has to approve the requestpasStatus
- The request status to filter by. If no value is specified then it looks for all requests irrespective of status.pbUserPending
- Boolean indicating whether to only display those requests that are pending approval by the specified user. True indicates only show those where the approval task assigned to the specified user is pending. False means show all without filteringtcAPIException
tcUserNotFoundException
boolean requiresInstanceResolution(long plRequestKey) throws tcAPIException, tcRequestNotFoundException, tcAPIException
plRequestKey
- The Key of the Request.tcAPIException
tcRequestNotFoundException
Thor.API.tcResultSet getInstanceResolutionListForUser(long plRequestKey, long plUserKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcRequestUserInvalidException, tcAPIException
plRequestKey
- The Key of the Request.plUserKey
- The Key of the Target User. Specify 0 to get the list for all target users in the request.plObjectKey
- The Key of the Object. Specify 0 to get the list for all objects in the request.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestUserInvalidException
Thor.API.tcResultSet getInstanceResolutionListForOrg(long plRequestKey, long plOrganizationKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcRequestOrganizationInvalidException, tcAPIException
plRequestKey
- The Key of the Request.plOrganizationKey
- The Key of the Target Organization. Specify 0 to get the list for all target organizations in the request.plObjectKey
- The Key of the Object. Specify 0 to get the list for all objects in the request.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestOrganizationInvalidException
Thor.API.tcResultSet getInstanceResolutionOptionsForUser(long plRequestKey, long plUserKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcRequestUserInvalidException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.plUserKey
- The Key of the Target User.plObjectKey
- The Key of the Object.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestUserInvalidException
tcWrongRequestActionException
and
, methods.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.
Thor.API.tcResultSet getInstanceResolutionOptionsForOrg(long plRequestKey, long plOrganizationKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcRequestOrganizationInvalidException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.plOrganizationKey
- The Key of the Target Organization.plObjectKey
- The Key of the Object.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestOrganizationInvalidException
tcWrongRequestActionException
and
, methods.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.
Thor.API.tcResultSet getSelectedInstancesForUser(long plRequestKey, long plUserKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcRequestUserInvalidException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.plUserKey
- The Key of the Target User. Provide 0 if all selections for the request irrespective of user are required.plObjectKey
- The Key of the Object. Provide 0 if all selections for the request irrespective of object are required.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestUserInvalidException
tcWrongRequestActionException
Thor.API.tcResultSet getSelectedInstancesForOrg(long plRequestKey, long plOrganizationKey, long plObjectKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcRequestOrganizationInvalidException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.plOrganizationKey
- The Key of the Target Organization. Provide 0 if all selections for the request irrespective of organization are required.plObjectKey
- The Key of the Object. Provide 0 if all selections for the request irrespective of object are required.tcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
tcRequestOrganizationInvalidException
tcWrongRequestActionException
void selectInstancesForUser(long plRequestKey, long[] palObjectInstanceForUserKeys) throws tcAPIException, tcRequestNotFoundException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.palObjectInstanceForUserKeys
- An array of Object Instance For User Keys.tcAPIException
tcRequestNotFoundException
tcWrongRequestActionException
method.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.
void selectInstancesForOrganization(long plRequestKey, long[] palObjectInstanceForOrganizationKeys) throws tcAPIException, tcRequestNotFoundException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.palObjectInstanceForOrganizationKeys
- An array of Object Instance For Organization Keys.tcAPIException
tcRequestNotFoundException
tcWrongRequestActionException
method.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.
void deselectInstancesForUser(long plRequestKey, long[] palObjectInstanceForUserKeys) throws tcAPIException, tcRequestNotFoundException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.palObjectInstanceForUserKeys
- An array of Object Instance For User Keys.tcAPIException
tcRequestNotFoundException
tcWrongRequestActionException
method.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.
void deselectInstancesForOrganization(long plRequestKey, long[] palObjectInstanceForOrganizationKeys) throws tcAPIException, tcRequestNotFoundException, tcWrongRequestActionException, tcAPIException
plRequestKey
- The Key of the Request.palObjectInstanceForOrganizationKeys
- An array of Object Instance For Organization Keys.tcAPIException
tcRequestNotFoundException
tcWrongRequestActionException
method.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.
void setResourceResponse(long plUserKey, long plObjectInstanceKey, java.lang.String psResponse) throws tcAPIException, tcInvalidResponseException, tcAPIException
plUserKey
- The key of the User setting the responseplObjectInstanceKey
- The key for the Resource Object Instance.psResponse
- The response to set for the requesttcAPIException
tcInvalidResponseException
java.lang.String[][] getRequestHistory(java.lang.String reqID) throws tcRequestInvalidException, tcAPIException, tcAPIException
reqID
- - the request ID returned when creating the requesttcRequestInvalidException
tcAPIException
Thor.API.tcResultSet getRegistrationUserDetails(long reqKey) throws tcRequestInvalidException, tcAPIException, tcAPIException
reqKey
- The Request keytcRequestInvalidException
tcAPIException
boolean isUserSelfRegistrationChallengeValuesProvided(long psRequestKey) throws tcRequestInvalidException, tcAPIException, tcAPIException
psRequestKey
- The Request KeytcRequestInvalidException
tcAPIException
void updateRegistrationUserDetails(long pnRequestKey, java.util.Map poAttributes) throws tcRequestInvalidException, tcOrganizationNotFoundException, tcAPIException, tcInvalidManagerException, tcDuplicateUserException, tcAPIException
pnRequestKey
- Request ID for which data is updatedpoAttributes
- Key Value pair (the way, value was passed to createRegistrationRequest method in tcUtilityFactory)tcRequestInvalidException
tcOrganizationNotFoundException
tcAPIException
tcInvalidManagerException
tcDuplicateUserException
com.thortech.xl.orb.dataaccess.tcDataAccessException
void updateRegistrationUserDetails(long pnRequestKey, com.thortech.xl.orb.api.tcMapping[] poAttributes) throws tcRequestInvalidException, tcOrganizationNotFoundException, tcAPIException, tcInvalidManagerException, tcDuplicateUserException, com.thortech.xl.orb.dataaccess.tcDataAccessException, tcAPIException
pnRequestKey
- Request ID for which data is updatedpoAttributes
- Key Value pair (the way, value was passed to createRegistrationRequest method in tcUtilityFactory)tcRequestInvalidException
tcOrganizationNotFoundException
tcAPIException
tcInvalidManagerException
tcDuplicateUserException
com.thortech.xl.orb.dataaccess.tcDataAccessException
int getNumberOfApprovalTasksAssignedToUser(long userKey, java.lang.String[] statuses) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- The User Key of the user for whom to get the number of approval tasks.statuses
- An array
of statuses to filter the tasks by. If multiple statuses are specified, they are evaluated using the OR operator. If no status is specified then it looks for all tasks irrespective of status.tcUserNotFoundException
- raise if the user is not a valid user in the system.tcAPIException
- raise if there is a problem during the execution of the API.Thor.API.tcResultSet getApprovalTasksAssignedToUser(long userKey, java.util.Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.Thor.API.tcResultSet getApprovalTasksAssigned(java.util.Map attributeList) throws tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.Thor.API.tcResultSet getApprovalTasksAssignedToManagedUsers(long userKey, java.util.Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
-attributeList
-tcAPIException
- raise if a problem occurred when retrieving the information.tcUserNotFoundException
- raise if the user is not a valid user.tcAttributeNotFoundException
- raise if an attribute is not valid.getApprovalTasksAssignedToUser
void reassignApprovalTasksToUser(long[] taskInstanceKeys, long userKey) throws tcAPIException, tcUserNotFoundException, tcTaskNotFoundException, tcBulkException, tcAPIException
taskInstanceKeys
- array of task instances that need to be re-assigneduserKey
- the user key that all the task instance will re-assign totcAPIException
- raise if a problem occurred when retrieving the information.tcUserNotFoundException
- raise if the user is not a valid user.tcTaskNotFoundException
- raise if one or more task are not valid.tcBulkException
- raise if a problem occurred on any of the re-assigments of the task instance.void reassignApprovalTasksToGroup(long[] taskInstanceKeys, long groupKey) throws tcAPIException, tcGroupNotFoundException, tcTaskNotFoundException, tcBulkException, tcAPIException
taskInstanceKeys
- array of task instances that need to be re-assignedgroupKey
- the group key that all the task instance will re-assign totcAPIException
- raise if a problem occurred when retrieving the information.tcGroupNotFoundException
- raise if the group is not a valid group.tcTaskNotFoundException
- raise if one or more task are not valid.tcBulkException
- raise if a problem occurred on any of the re-assigments of the task instance.int getNumberOfRequestsCreatedForUser(long userKey, boolean pending) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- The user key of the user who the requests are created for.pending
- Boolean indicating whether to only count those requests that are pending. True indicates to only count the requests that are NOT in the following statuses:
tcUserNotFoundException
tcAPIException
int getNumberOfRequestsCreatedByUser(long userKey, boolean pending) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- The user key of the user who the requests are created by.pending
- Boolean indicating whether to only count those requests that are pending. True indicates to only count the requests that are NOT in the following statuses:
tcUserNotFoundException
tcAPIException
long getNumberOfPendingRequests(long userKey) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- the user to retrieve the pending approvals fortcUserNotFoundException
tcAPIException
void initiateRequestApproval(long reqKey) throws tcInvalidStatusException, tcAPIException, tcAPIException
reqKey
- the request to initiate the approval processtcInvalidStatusException
tcAPIException
Thor.API.tcResultSet getProvisioningDetail(long requestID) throws tcAPIException, tcAPIException
reqeustID
- the request key for the requesttcAPIException
- raise if a problem occurred when retrieving the information.Thor.API.tcResultSet getPendingApprovals(long requestID) throws tcAPIException, tcAPIException
reqeustID
- the request key for the requesttcAPIException
- raise if a problem occurred when retrieving the information.Thor.API.tcResultSet findObjects(java.lang.String actionType, java.lang.String[] targetKeys, java.lang.String type, java.lang.String[] statusesIn, java.lang.String[] statusesNotIn, java.util.Map searchCriteria) throws tcAPIException, tcAPIException
actionType
- Enable/Disable/RevoketargetKeys
- string array to hold either user keys or organization keystype
- U is user type, O is organization type.statusesIn
- A string array that specifies the statuses of the objects to be returnedstatusesNotIn
- A string array that specifies the statuses that the objects should not be in.searchCriteria.
- Object name and value pair need to be passed in.tcAPIException
- raise if a problem occurred when retrieving the information.Thor.API.tcResultSet findObjects(java.lang.String actionType, java.lang.String[] targetKeys, java.lang.String type, java.util.Map searchCriteria) throws tcAPIException, tcAPIException
actionType
- Enable/Disable/RevoketargetKeys
- string array to hold either user keys or organization keystype
- U is user type, O is organization type.searchCriteria.
- Object name and value pair need to be passed in.tcAPIException
- raise if a problem occurred when retrieving the information.void removeRequestObject(java.lang.String requestKey, java.lang.String objectInstanceKey) throws tcAPIException, tcRequestNotFoundException, tcRequestObjectInvalidException, tcAPIException
requestKey
- The key for the request to remove the object from.objectInstanceKey
- The key of the Object Instance to removetcAPIException
tcRequestNotFoundException
tcRequestObjectInvalidException
Thor.API.tcResultSet getSelectedResolutionInstances(java.lang.String requestKey, java.lang.String type) throws tcAPIException, tcAPIException
requestKey
- The Key of the Request.type
- U is for User. O is for OrganizationtcAPIException
Thor.API.tcResultSet getApprovalTasksAssignedToSubgroups(long userKey, java.util.Map attributeMap, boolean hierarchyOrder) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskshierarchyOrder
- a boolean that specifies the order of group hierarchy. If this is true, then we get all the parent groups and their member users. If this is false then we get all the subgroups and their member users.tcUserNotFoundException
- raised if the user is not a valid user.tcAPIException
- raised if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raised if an attribute is not valid.com.thortech.xl.vo.RequestDetail getRequestDetail(java.lang.String requestKey, java.lang.String requestID) throws tcAPIException
plRequstKey
- The request Key for the requesttcAPIException
Thor.API.tcResultSet getPendingApprovalTasksAssignedToUser(long userKey, java.util.Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.Thor.API.tcResultSet getPendingApprovalTasksAssignedToUserPaged(long userKey, java.util.Map attributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, boolean getTotalRowCount) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval tasksstartRow
- The starting row of the resultpageSize
- The page size (how many rows to return)order
- The sort order. The sorting is done only on database data.ascendingOrder
- - a boolean value if the sorting is to be ascending or descendinggetTotalRowCount
- - a boolean value if the get total number of rows along with paged resultstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.int getCountOfPendingApprovalTasksAssignedToUser(long userKey, java.util.Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.Thor.API.tcResultSet getPendingApprovalTasksAssigned(java.util.Map attributeList) throws tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.Thor.API.tcResultSet getPendingApprovalTasksAssignedToManagedUsers(long userKey, java.util.Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
-attributeList
-tcAPIException
- raise if a problem occurred when retrieving the information.tcUserNotFoundException
- raise if the user is not a valid user.tcAttributeNotFoundException
- raise if an attribute is not valid.getPendingApprovalTasksAssignedToUser
Thor.API.tcResultSet getPendingApprovalTasksAssignedToManagedUsersPaged(long userKey, java.util.Map attributeList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, boolean getTotalRowCount) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval tasksstartRow
- The starting row of the resultpageSize
- The page size (how many rows to return)The
- sort order. The sorting is done only on data from the database.ascendingOrder
- - a boolean value if the sorting is to be ascending or descendingtcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.long getNumberOfPendingRequestsAssignedToUser(long userKey) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- the user to retrieve the pending approvals fortcUserNotFoundException
tcAPIException
int getNumberOfPendingApprovalTasksAssignedToUser(long userKey) throws tcUserNotFoundException, tcAPIException, tcAPIException
userKey
- The User Key of the user for whom to get the number of approval tasks.tcUserNotFoundException
- raise if the user is not a valid user in the system.tcAPIException
- raise if there is a problem during the execution of the API.Thor.API.tcResultSet getPendingApprovalTasksAssignedToSubgroups(long userKey, java.util.Map attributeMap, boolean hierarchyOrder) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskshierarchyOrder
- a boolean that specifies the order of group hierarchy. If this is true, then we get all the parent groups and their member users. If this is false then we get all the subgroups and their member users.tcUserNotFoundException
- raised if the user is not a valid user.tcAPIException
- raised if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raised if an attribute is not valid.Thor.API.tcResultSet getGenericFindRequest(java.util.Map searchCriteria) throws tcAPIException, tcUserNotFoundException, tcObjectNotFoundException, tcAPIException
searchCriteria.
- Object name and value pair need to be passed in.tcAPIException
tcUserNotFoundException
tcObjectNotFoundException
Thor.API.tcResultSet getPendingApprovalTasksAssignedToSubgroupsPaged(long userKey, java.util.Map attributeMap, boolean hierarchyOrder, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder, boolean getTotalRowCount) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException, tcAPIException
userKey
- the user key to find the approval tasksattributeList
- the list of attributes that filter the search of approval taskshierarchyOrder
- a boolean that specifies the order of group hierarchy. If this is true, then we get all the parent groups and their member users. If this is false then we get all the subgroups and their member users.startRow
- The starting row of the resultpageSize
- The page size (how many rows to return)order
- The sort order. The sorting is done only on database data.ascendingOrder
- - a boolean value if the sorting is to be ascending or descendinggetTotalRowCount
- - a boolean value which specifies whether to get total number of rows along with paged resultstcUserNotFoundException
- raise if the user is not a valid user.tcAPIException
- raise if a problem occurred when retrieving the information.tcAttributeNotFoundException
- raise if an attribute is not valid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |