tcRequestOperationsIntf (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Thor.API.Operations
Interface tcRequestOperationsIntf

All Superinterfaces:: tcUtilityOperationsIntf

public interface tcRequestOperationsIntf

extends tcUtilityOperationsIntf

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

findRequests

Thor.API.tcResultSet findRequests(java.util.Map phAttributeList,
                                  int startRow,
                                  int pageSize,
                                  java.lang.String[] order,
                                  boolean ascendingOrder)
                                  throws tcAPIException,
                                         tcAPIException

Returns a list of requests that match the provided attribute list.

Parameters:

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 data

pageSize - the end row of the data to retrieve

order - an array of string to sort the result data

ascendingOrder - if the order should be in ascending or descending order

Returns:

A tcResultSet that contains any user-defined columns as well as the following Request-related information:

Objects.Object Status.Key
Objects.Object Status.Status
Process Instance.Key
RequestAdmin.First Name
RequestAdmin.Key
RequestAdmin.Last Name
RequestAdmin.User ID
Requester.First Name
Requester.Last Name
Requester.User ID
Requester.Manager Key
Requester.Manager First Name
Requester.Manager Last Name
Requester.Manager User ID
Requests.Created By
Requests.Creation Date
Requests.Key
Requests.Note
Requests.Object Request Type
Requests.Request ID
Requests.Request Priority
Requests.Row Version
Requests.Target Type
Requests.Type
Requests.Update Date
Requests.Updated By
Requests.Updated By First Name
Requests.Updated By Last Name
Requests.Updated By Login

Throws:

tcAPIException

findRequests

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

Returns a list of requests that match the provided attribute list.

Parameters:

startRow - the start row to retrieve the data

pageSize - the end row of the data to retrieve

order - an array of string to sort the result data

ascendingOrder - if the order should be in ascending or descending order

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.

Returns:

A tcResultSet that contains any user-defined columns as well as the following Request-related information:

Objects.Object Status.Key
Objects.Object Status.Status
Process Instance.Key
RequestAdmin.First Name
RequestAdmin.Key
RequestAdmin.Last Name
RequestAdmin.User ID
Requester.First Name
Requester.Last Name
Requester.User ID
Requester.Manager Key
Requester.Manager First Name
Requester.Manager Last Name
Requester.Manager User ID
Requests.Created By
Requests.Creation Date
Requests.Key
Requests.Note
Requests.Object Request Type
Requests.Request ID
Requests.Request Priority
Requests.Row Version
Requests.Target Type
Requests.Type
Requests.Update Date
Requests.Updated By
Requests.Updated By First Name
Requests.Updated By Last Name
Requests.Updated By Login

Throws:

tcAPIException

findRequests

Thor.API.tcResultSet findRequests(java.util.Map phAttributeList)
                                  throws tcAPIException,
                                         tcAPIException

Returns a list of requests that match the provided attribute list.

Parameters:

Returns:

A tcResultSet that contains any user-defined columns as well as the following Request-related information:

Objects.Object Status.Key
Objects.Object Status.Status
Process Instance.Key
RequestAdmin.First Name
RequestAdmin.Key
RequestAdmin.Last Name
RequestAdmin.User ID
Requester.First Name
Requester.Last Name
Requester.User ID
Requester.Manager Key
Requester.Manager First Name
Requester.Manager Last Name
Requester.Manager User ID
Requests.Created By
Requests.Creation Date
Requests.Key
Requests.Note
Requests.Object Request Type
Requests.Request ID
Requests.Request Priority
Requests.Row Version
Requests.Target Type
Requests.Type
Requests.Update Date
Requests.Updated By
Requests.Updated By First Name
Requests.Updated By Last Name
Requests.Updated By Login

Throws:

tcAPIException

findRequests

Thor.API.tcResultSet findRequests(java.util.Map phAttributeList,
                                  java.util.Date startDate,
                                  java.util.Date endDate)
                                  throws tcAPIException,
                                         tcAPIException

Returns a list of requests that match the provided attribute list.

Parameters:

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.

Returns:

A tcResultSet that contains any user-defined columns as well as the following Request-related information:

Objects.Object Status.Key
Objects.Object Status.Status
Process Instance.Key
RequestAdmin.First Name
RequestAdmin.Key
RequestAdmin.Last Name
RequestAdmin.User ID
Requester.First Name
Requester.Last Name
Requester.User ID
Requester.Manager Key
Requester.Manager First Name
Requester.Manager Last Name
Requester.Manager User ID
Requests.Created By
Requests.Creation Date
Requests.Key
Requests.Note
Requests.Object Request Type
Requests.Request ID
Requests.Request Priority
Requests.Row Version
Requests.Target Type
Requests.Type
Requests.Update Date
Requests.Updated By
Requests.Updated By First Name
Requests.Updated By Last Name
Requests.Updated By Login

Throws:

tcAPIException

findRequests

Thor.API.tcResultSet findRequests(long[] requests)
                                  throws tcAPIException,
                                         tcAPIException

Find information about given request collection. Resultset returned by this method will have the same columns outlined in the other findRequests method.

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.

Returns:: resultset containing information about given requests
Throws:: tcAPIException
See Also:: for more details on the result set returned.

findRequestsByDate

Thor.API.tcResultSet findRequestsByDate(java.util.Date pdStartDate,
                                        java.util.Date pdEndDate)
                                        throws tcAPIException,
                                               tcAPIException

Returns a list of requests (in the form of a tcResultSet) that were made between the specified times

Parameters:: 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.
Returns:: A tcResultSet in which each row holds information about the request.
Throws:: tcAPIException

findRequestsAfterDate

Thor.API.tcResultSet findRequestsAfterDate(java.util.Date pdStartDate)
                                           throws tcAPIException,
                                                  tcAPIException

Returns a list of requests (in the form of a tcResultSet) that were made after the specified date

Parameters:: pdStartDate - The long representation of the date and time after which the request should have been made.
Returns:: A tcResultSet in which each row holds information about the request.
Throws:: tcAPIException

findRequestsBeforeDate

Thor.API.tcResultSet findRequestsBeforeDate(java.util.Date pdEndDate)
                                            throws tcAPIException,
                                                   tcAPIException

Returns a list of requests (in the form of a tcResultSet) that were made before the specified time

Parameters:: pdEndDate - The long representation of the date and time before which the request should have been made.
Returns:: A tcResultSet in which each row holds information about the request.
Throws:: tcAPIException

findRequestsByStatusDate

Thor.API.tcResultSet findRequestsByStatusDate(java.lang.String[] pasStatus,
                                              java.util.Date pdStartDate,
                                              java.util.Date pdEndDate)
                                              throws tcAPIException,
                                                     tcAPIException

Returns a list of requests (in the form of a tcResultSet) whose status was the specified value between the specified times

Parameters:

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 status

pdEndDate - The long representation of the date and time before which the request should have has this status.

Returns:

A tcResultSet that contains any user-defined columns as well as the following Request-related information:

Objects.Object Status.Key
Objects.Object Status.Status
Process Instance.Key
Request History.Created By
Request History.Creation Date
Request History.Key
RequestAdmin.First Name
RequestAdmin.Key
RequestAdmin.Last Name
RequestAdmin.User ID
Requester.First Name
Requester.Last Name
Requester.User ID
Requests.Created By
Requests.Creation Date
Requests.Key
Requests.Note
Requests.Object Request Type
Requests.Request ID
Requests.Request Priority
Requests.Row Version
Requests.Target Type
Requests.Type
Requests.Update Date
Requests.Updated By

Throws:

tcAPIException

findRequestsByStatusAfterDate

Thor.API.tcResultSet findRequestsByStatusAfterDate(java.lang.String[] pasStatus,
                                                   java.util.Date pdStartDate)
                                                   throws tcAPIException,
                                                          tcAPIException

Returns a list of requests (in the form of a tcResultSet) whose status was the specified value after the specified date

Parameters:: pasStatus - The status to filter on; pdStartDate - The long representation of the date and time after which the request should have had the specified status.
Returns:: A tcResultSet in which each row holds information about the request.
Throws:: tcAPIException

findRequestsByStatusBeforeDate

Thor.API.tcResultSet findRequestsByStatusBeforeDate(java.lang.String[] pasStatus,
                                                    java.util.Date pdEndDate)
                                                    throws tcAPIException,
                                                           tcAPIException

Returns a list of requests (in the form of a tcResultSet) whose status was the specified value before the specified time

Parameters:: pasStatus - The status to filter on; pdEndDate - The long representation of the date and time before which the request should have had the specified status.
Returns:: A tcResultSet in which each row holds information about the request.
Throws:: tcAPIException

getRequestsForObject

Thor.API.tcResultSet getRequestsForObject(java.lang.String psObjectName,
                                          java.lang.String[] pasStatus)
                                          throws tcAPIException,
                                                 tcObjectNotFoundException,
                                                 tcAPIException

Returns a list of requests (in the form of a tcResultSet) for the specified object. It also can narrow down the requests by the status.

Parameters:: 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.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcObjectNotFoundException

getRequestsForUserTarget

Thor.API.tcResultSet getRequestsForUserTarget(long plUserKey,
                                              java.lang.String[] pasStatus,
                                              java.util.Date pdEndDate)
                                              throws tcAPIException,
                                                     tcUserNotFoundException,
                                                     tcAPIException

Returns a list of requests (in the form of a tcResultSet) made for the specified user. It also can narrow down the requests by the status.

Parameters:: 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.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException
Since:: 9.1.0.0

getRequestsForUserTarget

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

Returns a list of requests (in the form of a tcResultSet) made for the specified user. It also can narrow down the requests by the status.

Parameters:: 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 Criteria; 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.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException

getRequestsForUserTarget

Thor.API.tcResultSet getRequestsForUserTarget(long plUserKey,
                                              java.lang.String[] pasStatus,
                                              java.util.Map attributeList)
                                              throws tcAPIException,
                                                     tcUserNotFoundException,
                                                     tcAPIException

Returns a list of requests (in the form of a tcResultSet) made for the specified user. It also can narrow down the requests by the status.

Parameters:: 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 Criteria
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException

getNumberOfRequestsCreatedByUser

int getNumberOfRequestsCreatedByUser(java.util.Map phAttributeMap)
                                     throws tcUserNotFoundException,
                                            tcAPIException,
                                            tcAPIException

Returns the number of requests that have been created by a specific user.

Parameters:: userKey - The user key of the user who the requests are created by.
Returns:: An integer representing the number of requests.
Throws:: tcUserNotFoundException; tcAPIException
Since:: 9.0.1.2.1

getNumberOfRequestsForTargetUser

int getNumberOfRequestsForTargetUser(long userKey)
                                     throws tcAPIException,
                                            tcUserNotFoundException,
                                            tcAPIException

Returns the number of Requests raised for a given user.

Parameters:: userKey - The User Key of the user for whom requests have been raise for.
Throws:: tcAPIException - raised if an exception is encountered; tcUserNotFoundException - raised if the user key passed is not valid
Since:: 8.5

getRequestsForOrganizationTarget

Thor.API.tcResultSet getRequestsForOrganizationTarget(long plOrganizationKey,
                                                      java.lang.String[] pasStatus)
                                                      throws tcAPIException,
                                                             tcOrganizationNotFoundException,
                                                             tcAPIException

Returns a list of requests (in the form of a tcResultSet) made for the specified organization. It also can narrow down the requests by the status.

Parameters:: 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.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcOrganizationNotFoundException

getRequestsAssignedForApproval

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

Returns a list of requests (in the form of a tcResultSet) that are assigned to the given user for approval.

Parameters:: userKey - The User Key of the user who has to approve the request; status - 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 filtering; endDate - The date and time before which the request should have been made.; startRow - The starting row of the requests that match the given criteria; pageSize - is the number of records to return starting from startRow; order - is a String array of order columns to sort the matching records; ascendingOrder - is a boolean value referring if the order should be ascending (true) or descending (false).
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException - general exception if there is a problem processing the require data; tcUserNotFoundException - if the userKey given is not found in the database

getRequestsAssignedForApproval

Thor.API.tcResultSet getRequestsAssignedForApproval(long plUserKey,
                                                    java.lang.String[] pasStatus,
                                                    boolean pbUserPending,
                                                    java.util.Date pdEndDate)
                                                    throws tcAPIException,
                                                           tcUserNotFoundException,
                                                           tcAPIException

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. Can be filtered based on the request status and whether user's approval is pending.

Parameters:: plUserKey - The User Key of the user who has to approve the request; pasStatus - 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 filtering; pdEndDate - The date and time before which the request should have been made.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException

getRequestsAssignedForApproval

Thor.API.tcResultSet getRequestsAssignedForApproval(long plUserKey,
                                                    java.lang.String[] pasStatus,
                                                    boolean pbUserPending)
                                                    throws tcAPIException,
                                                           tcUserNotFoundException,
                                                           tcAPIException

Searches for all the requests that have an approval process in which one of the approval tasks is assigned to the specified user. Can be filtered based on the Request Status, and whether users approval is pending

Parameters:: plUserKey - The User Key of the user who has to approve the request; pasStatus - 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 filtering
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException

getRequestTargetsForAdditionalFeilds

Thor.API.tcResultSet getRequestTargetsForAdditionalFeilds(long plRequestKey,
                                                          java.util.List feilds)
                                                          throws tcAPIException,
                                                                 tcRequestNotFoundException,
                                                                 tcAPIException

Retrieves all the targets (users or organizations) for whom the request is being made.

Parameters:: plRequestKey - The Request Key of the request to get the targets for; feilds - The additianal feilds which needs to be displayed in request details.
Returns:: A tcResultSet in which each row holds information about the target
Throws:: tcAPIException; tcRequestNotFoundException

getRequestTargets

Thor.API.tcResultSet getRequestTargets(long plRequestKey)
                                       throws tcAPIException,
                                              tcRequestNotFoundException,
                                              tcAPIException

Retrieves all the targets (users or organizations) for whom the request is being made.

Parameters:: plRequestKey - The Request Key of the request to get the targets for
Returns:: A tcResultSet in which each row holds information about the target
Throws:: tcAPIException; tcRequestNotFoundException

getRequestObjects

Thor.API.tcResultSet getRequestObjects(long plRequestKey)
                                       throws tcAPIException,
                                              tcRequestNotFoundException,
                                              tcAPIException

Retrieves all the objects being requested

Parameters:: plRequestKey - The Request Key of the request to get the objects for
Returns:: A tcResultSet in which each row holds information about the object
Throws:: tcAPIException; tcRequestNotFoundException

isResourceApprovable

boolean isResourceApprovable(long plObjectInstanceKey,
                             long plUserKey)
                             throws tcAPIException,
                                    tcAPIException

Checks wheather the resource can be approved by this user

Parameters:: plObjectInstanceKey - Resource instance; plUserKey - User Key
Returns:: Returns true if the user has the rights to approve the resource
Throws:: tcAPIException

getRequestComments

Thor.API.tcResultSet getRequestComments(long plRequestKey,
                                        java.lang.String psCommentType)
                                        throws tcAPIException,
                                               tcRequestNotFoundException,
                                               tcAPIException

Retrieves all the comments for a request. Can also filter based on comment type.

Parameters:

plRequestKey - The key of the request to get comments for

psCommentType - 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.

Returns:

A tcResultSet that contains the following information about the specified request's comments:

Requests.Comments.Comments
Requests.Comments.Created By
Requests.Comments.Creation Date
Requests.Comments.Key
Requests.Comments.Note
Requests.Comments.Row Version
Requests.Comments.Type
Requests.Comments.Update Date
Requests.Comments.Updated By
Requests.Comments.Created By First Name
Requests.Comments.Created By Last Name
Requests.Comments.Created By Login

Throws:

tcAPIException

tcRequestNotFoundException

getRequestAdministrativeGroups

Thor.API.tcResultSet getRequestAdministrativeGroups(long plRequestKey)
                                                    throws tcAPIException,
                                                           tcRequestNotFoundException,
                                                           tcAPIException

Retrieves all the administrative groups for a request.

Parameters:: plRequestKey - The Request Key of the request to get the administrative groups for
Returns:: A tcResultSet in which each row holds information about an administrative group and its privileges.
Throws:: tcAPIException; tcRequestNotFoundException

getRequestStatusHistory

Thor.API.tcResultSet getRequestStatusHistory(long plRequestKey)
                                             throws tcAPIException,
                                                    tcRequestNotFoundException,
                                                    tcAPIException

Retrieves the status history of the request.

Parameters:

plRequestKey - The key of the request to get the status history for

Returns:

A tcResultSet that contains the following information about the request status history:

Request History.Creation Date
Request History.Key
Request History.Status
Users.First Name
Users.Key
Users.Last Name
Users.User ID

Note that the user information above pertains to the user who created the request status.

Throws:

tcAPIException

tcRequestNotFoundException

getRequestObjectStatusHistory

Thor.API.tcResultSet getRequestObjectStatusHistory(long plRequestKey,
                                                   long plObjectInstanceKey)
                                                   throws tcAPIException,
                                                          tcRequestNotFoundException,
                                                          tcRequestObjectInvalidException,
                                                          tcAPIException

Retrieves the status history of the specified request object

Parameters:

plRequestKey - The key of the request to get the status history for

plObjectInstanceKey - The key of the object instance

Returns:

A tcResultSet that contains the following information about the request status history:

Request History.Creation Date
Request History.Key
Request History.Status
Users.First Name
Users.Key
Users.Last Name
Users.User ID

Note that the user information above pertains to the user who created the request status.

Throws:

tcAPIException

tcRequestNotFoundException

tcRequestObjectInvalidException

getRequestObjectTargetInstanceKeys

Thor.API.tcResultSet getRequestObjectTargetInstanceKeys(long plRequestKey,
                                                        long plObjectInstanceKey)
                                                        throws tcAPIException,
                                                               tcRequestNotFoundException,
                                                               tcRequestObjectInvalidException,
                                                               tcAPIException

Retrieves the object instance keys for targets for the specified request and request object instance. the targets could be the users or the organizations, depending on whether the request was for user targets or organization targets.

Parameters:: plRequestKey - The Request Key of the request to get the objects for; plObjectInstanceKey - The key of the object instance
Returns:: A tcResultSet in which each row holds information about the object instance for target (user/organization) keys, and the target information.
If the request target is "User", the resultset returned contains "Users-Object Instance For User.Key", "Users.Key", "Users.User ID", "Users.First Name", "Users.Last Name"
If the request target is "Organization", the resultset returned contains "Organization-Object Instance-Process Instance.Key", "Organizations.Key", "Organizations.Organization Name"
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException

createProfileModifyRequest

java.lang.String createProfileModifyRequest(java.util.Map attrs)
                                            throws tcRequiredDataMissingException,
                                                   tcAPIException,
                                                   tcOrganizationNotFoundException,
                                                   tcInvalidManagerException,
                                                   tcDuplicateUserException,
                                                   com.thortech.xl.orb.dataaccess.tcDataAccessException,
                                                   tcAPIException

Creates a user profile modification request.

Parameters:: attrs - AMap of name-value pairs, representing the user profile information being modified.
Returns:: The Request Key of the newly created request.
Throws:: tcRequiredDataMissingException; tcAPIException; tcOrganizationNotFoundException; tcInvalidManagerException; tcDuplicateUserException; com.thortech.xl.orb.dataaccess.tcDataAccessException

createRequest

long createRequest(java.util.Map phAttributeList)
                   throws tcAttributeMissingException,
                          tcInvalidAttributeException,
                          tcRequestInvalidException,
                          tcAPIException,
                          tcAPIException

Creates a request.

Parameters:: phAttributeList - A map of name-value pairs, each entry representing an attribute to be set for the request.
Returns:: The Request Key of the newly created request.
Throws:: tcAttributeMissingException; tcInvalidAttributeException; tcRequestInvalidException; tcAPIException

completeRequestCreation

void completeRequestCreation(long plRequestKey)
                             throws tcAPIException,
                                    tcRequestInvalidException,
                                    tcAPIException

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.

Parameters:: plRequestKey - The key for the request to update.
Throws:: tcAPIException; tcRequestInvalidException

updateRequest

void updateRequest(long plRequestKey,
                   java.util.Map phAttributeList)
                   throws tcAPIException,
                          tcRequestInvalidException,
                          tcInvalidUpdateException,
                          tcAPIException

Updates the specified attributes of a request. This deals with data about the request such as the priority, etc. Not all attributes of a request can be updated.

Parameters:: plRequestKey - The key for the request to update.; phAttributeList - The list of attribute-value pairs being updated
Throws:: tcAPIException; tcRequestInvalidException; tcInvalidUpdateException

cancelRequest

void cancelRequest(long plRequestKey)
                   throws tcAPIException,
                          tcRequestInvalidException,
                          tcAPIException

Cancels a request made in the system.

Parameters:: plRequestKey - The key for the request to cancel.
Throws:: tcAPIException; tcRequestInvalidException

cancelRequest

void cancelRequest(java.lang.String plRequestId)
                   throws tcAPIException,
                          tcRequestInvalidException,
                          tcAPIException

Cancels a request made in the system by the request Id.

Parameters:: plRequestId - The Id for the request to cancel.
Throws:: tcAPIException; tcRequestInvalidException
Since:: 9.1.0.0

closeRequest

void closeRequest(long plRequestKey)
                  throws tcAPIException,
                         tcRequestInvalidException,
                         tcAPIException

Closes a request made in the system.

Parameters:: plRequestKey - The key for the request to close.
Throws:: tcAPIException; tcRequestInvalidException

addRequestObjects

long[] addRequestObjects(long plRequestKey,
                         long[] plObjectKeys)
                         throws tcAPIException,
                                tcRequestNotFoundException,
                                tcRequestObjectInvalidException,
                                tcAPIException

Adds all Objects to be provisioned to a Request. Assumes it is not a service account

Parameters:: plRequestKey - The key for the request to add the object to.; plObjectKeys - The long array of Object keys to add.
Returns:: The long array of Object Instance keys of added resource object.
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException
Since:: 9.1

addRequestObject

long addRequestObject(long plRequestKey,
                      long plObjectKey)
                      throws tcAPIException,
                             tcRequestNotFoundException,
                             tcRequestObjectInvalidException,
                             tcAPIException

Deprecated.

Adds an Object to be provisioned to a Request. Assumes it is not a service account

Parameters:: plRequestKey - The key for the request to add the object to.; plObjectKey - The key of the Object to add
Returns:: The Object Instance key of added resource object.
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException
See Also:: tcRequestOperationsIntf.addRequestObjects(long plRequestKey, long[] plObjectKeys)

addRequestObject

long addRequestObject(long plRequestKey,
                      long plObjectKey,
                      boolean pbServiceAccount)
                      throws tcAPIException,
                             tcRequestNotFoundException,
                             tcRequestObjectInvalidException,
                             tcAPIException

Adds an Object to be provisioned to a Request

Parameters:: plRequestKey - The key for the request to add the object to.; plObjectKey - The key of the Object to add; pbServiceAccount - Whether the resource should be provisioned as a service account or not (True for yes)
Returns:: The Object Instance key of added resource object.
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException

setRequestObjectAsServiceAccountFlag

void setRequestObjectAsServiceAccountFlag(long plRequestKey,
                                          long plObjectInstanceKey,
                                          boolean pbServiceAccount)
                                          throws tcAPIException,
                                                 tcRequestNotFoundException,
                                                 tcRequestObjectInvalidException,
                                                 tcAPIException

Sets the flag on the requested object that indicates whether it is to be provisioned as a service account or not.

Parameters:: 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)
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException

removeRequestObject

void removeRequestObject(long plRequestKey,
                         long plObjectKey)
                         throws tcAPIException,
                                tcRequestNotFoundException,
                                tcRequestObjectInvalidException,
                                tcAPIException

Deletes an Object to be provisioned from a Request

Parameters:: plRequestKey - The key for the request to remove the object from.; plObjectKey - The key of the Object to remove
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException

canTriggerObject

boolean canTriggerObject(long plUserKey,
                         long plObjectInstanceKey)
                         throws tcAPIException,
                                tcUserNotFoundException,
                                tcRequestObjectInvalidException,
                                tcObjectNotApprovedException,
                                tcAPIException

Checks to see if the object being provisioned for a request can be triggered. The user must have write permissions to a queue that is assigned to the object and the object instance must have the status, "Approved, Ready To Provision."

Parameters:: plUserKey - The key of the user; plObjectInstanceKey - The key of the object instance
Returns:: True if the object can be triggered. False if it cannot.
Throws:: tcAPIException; tcUserNotFoundException; tcRequestObjectInvalidException; tcObjectNotApprovedException

triggerRequestObject

void triggerRequestObject(long plRequestKey,
                          long plObjectInstanceKey)
                          throws tcAPIException,
                                 tcRequestNotFoundException,
                                 tcRequestObjectInvalidException,
                                 tcObjectNotApprovedException,
                                 tcAPIException

Trigger execution of an Object being provisioned for a Request

Parameters:: plRequestKey - The key for the request to trigger the object for; plObjectInstanceKey - The key of the object instance
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcObjectNotApprovedException

addRequestUser

void addRequestUser(long plRequestKey,
                    long plUserKey)
                    throws tcAPIException,
                           tcRequestNotFoundException,
                           tcRequestUserInvalidException,
                           tcAPIException

Adds to a Request a User to be provisioned for.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User to add as a target for the request
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestUserInvalidException

removeRequestUser

void removeRequestUser(long plRequestKey,
                       long plUserKey)
                       throws tcAPIException,
                              tcRequestNotFoundException,
                              tcRequestUserInvalidException,
                              tcAPIException

Deletes from a Request a User to be provisioned for.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User to remove as a target for the request
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestUserInvalidException

addRequestOrganization

void addRequestOrganization(long plRequestKey,
                            long plOrganizationKey)
                            throws tcAPIException,
                                   tcRequestNotFoundException,
                                   tcRequestOrganizationInvalidException,
                                   tcAPIException

Adds to a Request an Organization to be provisioned for.

Parameters:: plRequestKey - The key for the Request.; plOrganizationKey - The key of the Organization to add as a target for the request
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestOrganizationInvalidException

removeRequestOrganization

void removeRequestOrganization(long plRequestKey,
                               long plOrganizationKey)
                               throws tcAPIException,
                                      tcRequestNotFoundException,
                                      tcRequestOrganizationInvalidException,
                                      tcAPIException

Removes from a Request an Organization to be provisioned for.

Parameters:: plRequestKey - The key for the Request.; plOrganizationKey - The key of the Organization to remove as a target for the request
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestOrganizationInvalidException

addRequestComment

void addRequestComment(long plRequestKey,
                       java.lang.String psComment,
                       java.lang.String psCommentType)
                       throws tcAPIException,
                              tcRequestNotFoundException,
                              tcRequestCommentInvalidException,
                              tcAPIException

Adds a user comment to a Request.

Parameters:: plRequestKey - The key for the Request.; psComment - The comment to add to the request; psCommentType - The type of comment being added. Its value is based on LKU where code = Lookup.Request Comments.Type
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestCommentInvalidException

addAdministrativeGroup

void addAdministrativeGroup(long plRequestKey,
                            long plGroupKey,
                            boolean pbWrite,
                            boolean pbDelete)
                            throws tcAPIException,
                                   tcGroupNotFoundException,
                                   tcRequestNotFoundException,
                                   tcAPIException

Adds an Administrative group to a request.

Parameters:: plRequestKey - The key for the Request.; plGroupKey - The key of the Group to add as an administrator for the request; pbWrite - Whether the group has write access to the group; pbDelete - Whether the group has delete access to the group
Throws:: tcAPIException; tcGroupNotFoundException; tcRequestNotFoundException

updateAdministrativeGroup

void updateAdministrativeGroup(long plRequestKey,
                               long plGroupKey,
                               boolean pbWrite,
                               boolean pbDelete)
                               throws tcAPIException,
                                      tcAdminNotFoundException,
                                      tcGroupNotFoundException,
                                      tcRequestNotFoundException,
                                      tcAPIException

Update the access an Administrative group has to a request.

Parameters:: plRequestKey - The key for the Request.; plGroupKey - The key of the Group to update the permissions for; pbWrite - Whether the group has write access to the group; pbDelete - Whether the group has delete access to the group
Throws:: tcAPIException; tcAdminNotFoundException; tcGroupNotFoundException; tcRequestNotFoundException

removeAdministrativeGroup

void removeAdministrativeGroup(long plRequestKey,
                               long plGroupKey)
                               throws tcAPIException,
                                      tcAdminNotFoundException,
                                      tcGroupNotFoundException,
                                      tcRequestNotFoundException,
                                      tcRequestGroupInvalidException,
                                      tcAPIException

Remove an Administrative group from a request.

Parameters:: plRequestKey - The key for the Request.; plGroupKey - The key of the Group to remove as an administrator for the request
Throws:: tcAPIException; tcAdminNotFoundException; tcGroupNotFoundException; tcRequestNotFoundException; tcRequestGroupInvalidException

assignRequestToUser

void assignRequestToUser(long plRequestKey,
                         long plUserKey)
                         throws tcAdministratorAlreadyAssignedException,
                                tcAPIException,
                                tcInvalidUserException,
                                tcRequestNotFoundException,
                                tcUserNotFoundException,
                                tcAPIException

Assigns an Administrator to a request. This can only be done if the request does not have a current administrator. The user being assigned must be a member of one of the groups assigned with administrative privileges to this request.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User to assign as an administrator
Throws:: tcAdministratorAlreadyAssignedException; tcAPIException; tcInvalidUserException; tcRequestNotFoundException; tcUserNotFoundException

isRequestCancellable

boolean isRequestCancellable(long plRequestKey,
                             long plUserKey)
                             throws tcAPIException,
                                    tcAPIException

Returns whether the specified user has the authority to cancel the specified request.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User whose privileges are to be checked
Returns:: True if the user can cancel the request. False if not.
Throws:: tcAPIException

isRequestUpdatable

boolean isRequestUpdatable(long plRequestKey,
                           long plUserKey)
                           throws tcAPIException,
                                  tcAPIException

Returns whether the specified user has the authority to update the specified request.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User whose privileges are to be checked
Returns:: True if the user can update the request. False if not.
Throws:: tcAPIException

isRequestApprovable

boolean isRequestApprovable(long plRequestKey,
                            long plUserKey)
                            throws tcAPIException,
                                   tcAPIException

Returns whether the specified user has the authority to approve the specified request.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User whose approval privileges are to be checked
Returns:: True if the user can approve the request. False if not.
Throws:: tcAPIException

getRequestRoles

java.lang.String[] getRequestRoles(long plRequestKey,
                                   long plUserKey)
                                   throws tcAPIException,
                                          tcAPIException

Returns the roles that the specified user plays in the specified request.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User whose request roles are to be checked
Returns:: A string array containing all the roles the user currently has in the request Valid values are "Requester", "Request Target", "Object Authorizer", the Xellerate Role of the user, and "Object Administrator".
Throws:: tcAPIException

getRequestResponses

java.lang.String[] getRequestResponses(long plRequestKey,
                                       long plUserKey)
                                       throws tcAPIException,
                                              tcAPIException

Returns the responses that the specified user can set for the specified request. This is useful when one would like to deal with the request as a whole rather than dealing with the tasks of the request approval processes. It aggregates all the possible responses for all the tasks that are currently assigned to or accessible to the specified user.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User whose possible responses are to be checked
Returns:: A String Array containing all the responses the user can set for the tasks in the approval processes of the request
Throws:: tcAPIException

setRequestResponse

void setRequestResponse(long plRequestKey,
                        long plUserKey,
                        java.lang.String psResponse)
                        throws tcAPIException,
                               tcInvalidResponseException,
                               tcAwaitingObjectDataCompletionException,
                               tcAwaitingApprovalDataCompletionException,
                               tcAPIException

Sets the specified response from the specified user on all the tasks in the specified request that the user has access to. It looks for all the tasks that are currently assigned to or accessible to the specified user. If the specified response is defined as a response for any of those tasks then the response is set on those tasks (and those tasks only)

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User setting the response; psResponse - The response to set for the request
Throws:: tcAPIException; tcInvalidResponseException; tcAwaitingObjectDataCompletionException; tcAwaitingApprovalDataCompletionException

requestMoreInfoFromUser

void requestMoreInfoFromUser(long plRequestKey,
                             long plUserKey)
                             throws tcAPIException,
                                    tcInvalidResponseException,
                                    tcRequestApprovedException,
                                    tcAPIException

Initiates a request more info in the system for a specified request. The request for more information is sent to the specified user. The user may have been selected previously based on their role in the request, e.g. it may be a user who the request was made for, or it may be the requester.

Parameters:: plRequestKey - The key for the Request.; plUserKey - The key of the User who must be notified to provide more information for this request.
Throws:: tcAPIException; tcInvalidResponseException; tcRequestApprovedException

requestMoreInfoFromUserWithComment

void requestMoreInfoFromUserWithComment(long plRequestKey,
                                        long plUserKey,
                                        java.lang.String psComment)
                                        throws tcAPIException,
                                               tcInvalidResponseException,
                                               tcRequestApprovedException,
                                               tcAPIException

Parameters:: 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 user
Throws:: tcAPIException; tcInvalidResponseException; tcRequestApprovedException

requestMoreInfoFromUserForResource

void requestMoreInfoFromUserForResource(long plRequestKey,
                                        long plUserKey,
                                        long plObjectKey)
                                        throws tcAPIException,
                                               tcInvalidResponseException,
                                               tcRequestApprovedException,
                                               tcAPIException

Initiates a request more info in the system for a specified resource object of a request. The request for more information is sent to the specified user. The user may have been selected previously based on their role in the request, e.g. it may be a user who the request was made for, or it may be the requester.

Parameters:: 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 object
Throws:: tcAPIException; tcInvalidResponseException; tcRequestApprovedException

requestMoreInfoFromUserWithCommentForResource

void requestMoreInfoFromUserWithCommentForResource(long plRequestKey,
                                                   long plUserKey,
                                                   long plObjectKey,
                                                   java.lang.String psComment)
                                                   throws tcAPIException,
                                                          tcInvalidResponseException,
                                                          tcRequestApprovedException,
                                                          tcAPIException

Parameters:: 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 object; psComment - The comment of the user
Throws:: tcAPIException; tcInvalidResponseException; tcRequestApprovedException

requestMoreInfoFromGroup

void requestMoreInfoFromGroup(long plRequestKey,
                              long plGroupKey)
                              throws tcAPIException,
                                     tcInvalidResponseException,
                                     tcRequestApprovedException,
                                     tcAPIException

Initiates a request more info in the system for a specified request. The request for more information is sent to the specified group. The group may have been selected previously based on their role in the request, e.g. it may be a group acting as an object authorizer in the system.

Parameters:: plRequestKey - The key for the Request.; plGroupKey - The key of the Group that must be notified to provide more information for this request.
Throws:: tcAPIException; tcInvalidResponseException; tcRequestApprovedException

requestMoreInfoFromGroupWithComment

void requestMoreInfoFromGroupWithComment(long plRequestKey,
                                         long plGroupKey,
                                         java.lang.String psComment)
                                         throws tcAPIException,
                                                tcInvalidResponseException,
                                                tcRequestApprovedException,
                                                tcAPIException

Parameters:: 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.
Throws:: tcAPIException; tcInvalidResponseException; tcRequestApprovedException

getRequestTypes

java.lang.String[] getRequestTypes()
                                   throws tcAPIException,
                                          tcAPIException

Returns all the request types defined in the Xellerate system.

Returns:: An array of strings, each string a valid request type
Throws:: tcAPIException

getRequestStages

java.lang.String[][] getRequestStages(long plRequestKey)
                                      throws tcAPIException,
                                             tcAPIException

Returns all the stages identified for the specified request, and what status each stage is in.

Parameters:: plRequestKey - The key for the Request.
Returns:: A two dimensional string array with two columns, one the stage name the other the status of the stage
Throws:: tcAPIException

getRequestsForQueue

Thor.API.tcResultSet getRequestsForQueue(long plQueueKey)
                                         throws tcQueueNotFoundException,
                                                tcAPIException,
                                                tcAPIException

Returns a list of requests (in the form of a tcResultSet) for the specified queue.

Parameters:: plQueueKey - The key for the Queue.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcQueueNotFoundException; tcAPIException

getRequestsForQueueByStatus

Thor.API.tcResultSet getRequestsForQueueByStatus(long plQueueKey,
                                                 java.lang.String[] pasStatus)
                                                 throws tcQueueNotFoundException,
                                                        tcAPIException,
                                                        tcAPIException

Returns a list of requests (in the form of a tcResultSet) which have the given status for the specified queue.

Parameters:: plQueueKey - The key for the Queue.; pasStatus - The status of the requests which would be returned
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcQueueNotFoundException; tcAPIException

getQueuesForRequest

Thor.API.tcResultSet getQueuesForRequest(long plRequestKey)
                                         throws tcRequestNotFoundException,
                                                tcAPIException,
                                                tcAPIException

Returns a list of queues (in the form of a tcResultSet) for the specified request.

Parameters:: plRequestKey - The key for the Request.
Returns:: A tcResultSet in which each row holds information about the queue
Throws:: tcRequestNotFoundException; tcAPIException

assignQueue

void assignQueue(long plQueueKey,
                 long plRequestKey)
                 throws tcRequestNotFoundException,
                        tcQueueNotFoundException,
                        tcAPIException,
                        tcAPIException

Assigns a queue to a request

Parameters:: plQueueKey - The key for the Queue.; plRequestKey - The Key of the Request.
Throws:: tcRequestNotFoundException; tcQueueNotFoundException; tcAPIException

removeQueue

void removeQueue(long plQueueKey,
                 long plRequestKey)
                 throws tcRequestNotFoundException,
                        tcQueueNotFoundException,
                        tcAPIException,
                        tcAPIException

Removes a queue from a request

Parameters:: plQueueKey - The key for the Queue.; plRequestKey - The Key of the Request.
Throws:: tcRequestNotFoundException; tcQueueNotFoundException; tcAPIException

assignRequestObjectToQueue

void assignRequestObjectToQueue(long plQueueKey,
                                long plRequestKey,
                                long plObjectInstanceKey)
                                throws tcRequestNotFoundException,
                                       tcQueueNotFoundException,
                                       tcRequestObjectInvalidException,
                                       tcAPIException,
                                       tcAPIException

Assigns a Request Object to a particular queue

Parameters:: plQueueKey - The key for the Queue.; plRequestKey - The Key of the Request.; plObjectInstanceKey - The Key of the Request Object Instance.
Throws:: tcRequestNotFoundException; tcQueueNotFoundException; tcRequestObjectInvalidException; tcAPIException

removeRequestObjectFromQueue

void removeRequestObjectFromQueue(long plRequestKey,
                                  long plObjectInstanceKey)
                                  throws tcRequestNotFoundException,
                                         tcRequestObjectInvalidException,
                                         tcAPIException,
                                         tcAPIException

Removes a Request Object from its assigned queue

Parameters:: plRequestKey - The Key of the Request.; plObjectInstanceKey - The Key of the Request Object Instance.
Throws:: tcRequestNotFoundException; tcRequestObjectInvalidException; tcAPIException

assignRequestObjectToQueueAdmin

void assignRequestObjectToQueueAdmin(long plUserKey,
                                     long plRequestKey,
                                     long plObjectInstanceKey)
                                     throws tcRequestNotFoundException,
                                            tcUserNotFoundException,
                                            tcRequestObjectInvalidException,
                                            tcAPIException,
                                            tcAPIException

Assigns a Request Object to a particular Queue Admin

Parameters:: plUserKey - The key for the User.; plRequestKey - The Key of the Request.; plObjectInstanceKey - The Key of the Request Object Instance.
Throws:: tcRequestNotFoundException; tcUserNotFoundException; tcRequestObjectInvalidException; tcAPIException

getRequestsForAuthorization

Thor.API.tcResultSet getRequestsForAuthorization(long plUserKey,
                                                 java.lang.String[] pasStatus,
                                                 boolean pbUserPending)
                                                 throws tcAPIException,
                                                        tcUserNotFoundException,
                                                        tcAPIException

Returns all the requests that the given user is authorized to approve.

Parameters:: plUserKey - The User Key of the user who has to approve the request; pasStatus - 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 filtering
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException

requiresInstanceResolution

boolean requiresInstanceResolution(long plRequestKey)
                                   throws tcAPIException,
                                          tcRequestNotFoundException,
                                          tcAPIException

Indicates whether the specified request requires the requester to resolve object instance issues related to the objects in this request. This check is necessary only in the case of requests of type Disable/Enable/Revoke of objects.

Parameters:: plRequestKey - The Key of the Request.
Returns:: True if object instance resolution is required, False if not
Throws:: tcAPIException; tcRequestNotFoundException

getInstanceResolutionListForUser

Thor.API.tcResultSet getInstanceResolutionListForUser(long plRequestKey,
                                                      long plUserKey,
                                                      long plObjectKey)
                                                      throws tcAPIException,
                                                             tcRequestNotFoundException,
                                                             tcRequestObjectInvalidException,
                                                             tcRequestUserInvalidException,
                                                             tcAPIException

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. It can also be used to get all by not specifying the user or object keys.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

Parameters:: 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.
Returns:: Result set containing the matrix of users and objects that require an instance to be selected
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcRequestUserInvalidException

getInstanceResolutionListForOrg

Thor.API.tcResultSet getInstanceResolutionListForOrg(long plRequestKey,
                                                     long plOrganizationKey,
                                                     long plObjectKey)
                                                     throws tcAPIException,
                                                            tcRequestNotFoundException,
                                                            tcRequestObjectInvalidException,
                                                            tcRequestOrganizationInvalidException,
                                                            tcAPIException

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. It can also be used to get a greater list by not specifying the organization or object keys.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

Parameters:: 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.
Returns:: Result set containing the matrix of organizations and objects that require an instance to be selected
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcRequestOrganizationInvalidException

getInstanceResolutionOptionsForUser

Thor.API.tcResultSet getInstanceResolutionOptionsForUser(long plRequestKey,
                                                         long plUserKey,
                                                         long plObjectKey)
                                                         throws tcAPIException,
                                                                tcRequestNotFoundException,
                                                                tcRequestObjectInvalidException,
                                                                tcRequestUserInvalidException,
                                                                tcWrongRequestActionException,
                                                                tcAPIException

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.
If the request action is "Enable", it will only return instances that have a status of 'Disabled'.
If the request action is "Disable", it will only return instances that do not have a status of 'Disabled' or 'Revoked'.
If the request action is "Revoke", it will only return instances that do not have a status of 'Revoked'.
It also specifies if an instance is currently selected or not for this request.
The values returned here are the ones to be used when selecting or deselecting instances using the

Parameters:: plRequestKey - The Key of the Request.; plUserKey - The Key of the Target User.; plObjectKey - The Key of the Object.
Returns:: Result set containing the object instances of the specified object currently provisioned to the specified user that can be selected from
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcRequestUserInvalidException; tcWrongRequestActionException
See Also:: and, methods. This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

getInstanceResolutionOptionsForOrg

Thor.API.tcResultSet getInstanceResolutionOptionsForOrg(long plRequestKey,
                                                        long plOrganizationKey,
                                                        long plObjectKey)
                                                        throws tcAPIException,
                                                               tcRequestNotFoundException,
                                                               tcRequestObjectInvalidException,
                                                               tcRequestOrganizationInvalidException,
                                                               tcWrongRequestActionException,
                                                               tcAPIException

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.
If the request action is "Enable", it will only return instances that have a status of 'Disabled'.
If the request action is "Disable", it will only return instances that do not have a status of 'Disabled' or 'Revoked'.
If the request action is "Revoke", it will only return instances that do not have a status of 'Revoked'.
It also specifies if an instance is currently selected or not for this request.
The values returned here are the ones to be used when selecting or deselecting instances using the

Parameters:: plRequestKey - The Key of the Request.; plOrganizationKey - The Key of the Target Organization.; plObjectKey - The Key of the Object.
Returns:: Result set containing the object instances of the specified object currently provisioned to the specified organization that can be selected from
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcRequestOrganizationInvalidException; tcWrongRequestActionException
See Also:: and, methods. This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

getSelectedInstancesForUser

Thor.API.tcResultSet getSelectedInstancesForUser(long plRequestKey,
                                                 long plUserKey,
                                                 long plObjectKey)
                                                 throws tcAPIException,
                                                        tcRequestNotFoundException,
                                                        tcRequestObjectInvalidException,
                                                        tcRequestUserInvalidException,
                                                        tcWrongRequestActionException,
                                                        tcAPIException

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.
The values returned here are the ones that will be acted upon when the request enable/disable/revoke action is taken.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

Parameters:: 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.
Returns:: Result set containing information about the selected object instances of the specified object currently provisioned to the specified user to be acted upon in this request
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcRequestUserInvalidException; tcWrongRequestActionException

getSelectedInstancesForOrg

Thor.API.tcResultSet getSelectedInstancesForOrg(long plRequestKey,
                                                long plOrganizationKey,
                                                long plObjectKey)
                                                throws tcAPIException,
                                                       tcRequestNotFoundException,
                                                       tcRequestObjectInvalidException,
                                                       tcRequestOrganizationInvalidException,
                                                       tcWrongRequestActionException,
                                                       tcAPIException

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.
The values returned here are the ones that will be acted upon when the request enable/disable/revoke action is taken.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

Parameters:: 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.
Returns:: Result set containing information about the selected object instances of the specified object currently provisioned to the specified organization to be acted upon in this request
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException; tcRequestOrganizationInvalidException; tcWrongRequestActionException

selectInstancesForUser

void selectInstancesForUser(long plRequestKey,
                            long[] palObjectInstanceForUserKeys)
                            throws tcAPIException,
                                   tcRequestNotFoundException,
                                   tcWrongRequestActionException,
                                   tcAPIException

Allows the requester to select the specific instances of objects provisioned to a user that must be acted upon as part of the request. One or more instances can be selected by providing their Object Instance For User keys that are retrieved as part of the returned result set from the

Parameters:: plRequestKey - The Key of the Request.; palObjectInstanceForUserKeys - An array of Object Instance For User Keys.
Throws:: tcAPIException; tcRequestNotFoundException; tcWrongRequestActionException
See Also:: method. This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

selectInstancesForOrganization

void selectInstancesForOrganization(long plRequestKey,
                                    long[] palObjectInstanceForOrganizationKeys)
                                    throws tcAPIException,
                                           tcRequestNotFoundException,
                                           tcWrongRequestActionException,
                                           tcAPIException

Allows the requester to select the specific instances of objects provisioned to an organization that must be acted upon as part of the request. One or more instances can be selected by providing their Object Instance For Organization keys that are retrieved as part of the returned result set from the

Parameters:: plRequestKey - The Key of the Request.; palObjectInstanceForOrganizationKeys - An array of Object Instance For Organization Keys.
Throws:: tcAPIException; tcRequestNotFoundException; tcWrongRequestActionException
See Also:: method. This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

deselectInstancesForUser

void deselectInstancesForUser(long plRequestKey,
                              long[] palObjectInstanceForUserKeys)
                              throws tcAPIException,
                                     tcRequestNotFoundException,
                                     tcWrongRequestActionException,
                                     tcAPIException

Allows the requester to deselect the specific instances of objects provisioned to a user that must be acted upon as part of the request. One or more instances can be deselected by providing their Object Instance For User keys that are retrieved as part of the returned result set from the

Parameters:: plRequestKey - The Key of the Request.; palObjectInstanceForUserKeys - An array of Object Instance For User Keys.
Throws:: tcAPIException; tcRequestNotFoundException; tcWrongRequestActionException
See Also:: method. This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

deselectInstancesForOrganization

void deselectInstancesForOrganization(long plRequestKey,
                                      long[] palObjectInstanceForOrganizationKeys)
                                      throws tcAPIException,
                                             tcRequestNotFoundException,
                                             tcWrongRequestActionException,
                                             tcAPIException

Allows the requester to deselect the specific instances of objects provisioned to an organization that must be acted upon as part of the request. One or more instances can be deselected by providing their Object Instance For Organization keys that are retrieved as part of the returned result set from the

Parameters:: plRequestKey - The Key of the Request.; palObjectInstanceForOrganizationKeys - An array of Object Instance For Organization Keys.
Throws:: tcAPIException; tcRequestNotFoundException; tcWrongRequestActionException
See Also:: method. This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

setResourceResponse

void setResourceResponse(long plUserKey,
                         long plObjectInstanceKey,
                         java.lang.String psResponse)
                         throws tcAPIException,
                                tcInvalidResponseException,
                                tcAPIException

Sets the specified response from the specified user on all the tasks in the specified resource object instance that the user has access to. It looks for all the tasks that are currently assigned to or accessible to the specified user. If the specified response is defined as a response for any of those tasks then the response is set on those tasks (and those tasks only)

Parameters:: plUserKey - The key of the User setting the response; plObjectInstanceKey - The key for the Resource Object Instance.; psResponse - The response to set for the request
Throws:: tcAPIException; tcInvalidResponseException

getRequestHistory

java.lang.String[][] getRequestHistory(java.lang.String reqID)
                                       throws tcRequestInvalidException,
                                              tcAPIException,
                                              tcAPIException

Gets the history of the request since its submission. Each record indicates an action on the request.

Parameters:: reqID - - the request ID returned when creating the request
Returns:: - a table with columns and rows of request data. The columns returned are: Request Number, Creation Time, Request Priority, Request Status, Status Update Time.
Throws:: tcRequestInvalidException; tcAPIException

getRegistrationUserDetails

Thor.API.tcResultSet getRegistrationUserDetails(long reqKey)
                                                throws tcRequestInvalidException,
                                                       tcAPIException,
                                                       tcAPIException

This returns the request data associated with the given request. The data is in RQD for the given request. The return value is a result set with columns - rqd_attr_name, rqd_attr_value and rqd_display and rqd_encrypted. This API actually is generic, except that currently, it filters attr-value pair related to challenge questions sent through Registration request. Future Improvement: Make this more generic and allow for any kind of request and allow each kind of request to filter or modify data before returning.

Parameters:: reqKey - The Request key
Returns:: Returns the Thor.API.tcResultSet, which has the user registration deatils
Throws:: tcRequestInvalidException; tcAPIException

isUserSelfRegistrationChallengeValuesProvided

boolean isUserSelfRegistrationChallengeValuesProvided(long psRequestKey)
                                                      throws tcRequestInvalidException,
                                                             tcAPIException,
                                                             tcAPIException

Checks if user self registration challenge question and answers have been provided

Parameters:: psRequestKey - The Request Key
Returns:: True is user self registration challenge question and answers have been provided, false otherwise
Throws:: tcRequestInvalidException; tcAPIException

updateRegistrationUserDetails

void updateRegistrationUserDetails(long pnRequestKey,
                                   java.util.Map poAttributes)
                                   throws tcRequestInvalidException,
                                          tcOrganizationNotFoundException,
                                          tcAPIException,
                                          tcInvalidManagerException,
                                          tcDuplicateUserException,
                                          tcAPIException

Updates the request's data with the values passed.

Parameters:: pnRequestKey - Request ID for which data is updated; poAttributes - Key Value pair (the way, value was passed to createRegistrationRequest method in tcUtilityFactory)
Throws:: tcRequestInvalidException; tcOrganizationNotFoundException; tcAPIException; tcInvalidManagerException; tcDuplicateUserException; com.thortech.xl.orb.dataaccess.tcDataAccessException

updateRegistrationUserDetails

void updateRegistrationUserDetails(long pnRequestKey,
                                   com.thortech.xl.orb.api.tcMapping[] poAttributes)
                                   throws tcRequestInvalidException,
                                          tcOrganizationNotFoundException,
                                          tcAPIException,
                                          tcInvalidManagerException,
                                          tcDuplicateUserException,
                                          com.thortech.xl.orb.dataaccess.tcDataAccessException,
                                          tcAPIException

Updates the request's data with the values passed.

Parameters:: pnRequestKey - Request ID for which data is updated; poAttributes - Key Value pair (the way, value was passed to createRegistrationRequest method in tcUtilityFactory)
Throws:: tcRequestInvalidException; tcOrganizationNotFoundException; tcAPIException; tcInvalidManagerException; tcDuplicateUserException; com.thortech.xl.orb.dataaccess.tcDataAccessException

getNumberOfApprovalTasksAssignedToUser

int getNumberOfApprovalTasksAssignedToUser(long userKey,
                                           java.lang.String[] statuses)
                                           throws tcUserNotFoundException,
                                                  tcAPIException,
                                                  tcAPIException

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.

Parameters:: 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.
Returns:: the number of tasks assigned to the given user based on the given statuses
Throws:: 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.
Since:: 8.0

getApprovalTasksAssignedToUser

Thor.API.tcResultSet getApprovalTasksAssignedToUser(long userKey,
                                                    java.util.Map attributeList)
                                                    throws tcUserNotFoundException,
                                                           tcAPIException,
                                                           tcAttributeNotFoundException,
                                                           tcAPIException

This method returns a list of all the pending approval tasks that are assigned to the specified user. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set. This method returns tasks not only assigned to the user passed in as a parameter, but also the users who assigned the passed-in-user as a proxy. The same thing applies to groups as well.

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

8.0

getApprovalTasksAssigned

Thor.API.tcResultSet getApprovalTasksAssigned(java.util.Map attributeList)
                                              throws tcAPIException,
                                                     tcAttributeNotFoundException,
                                                     tcAPIException

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

8.0

getApprovalTasksAssignedToManagedUsers

Thor.API.tcResultSet getApprovalTasksAssignedToManagedUsers(long userKey,
                                                            java.util.Map attributeList)
                                                            throws tcUserNotFoundException,
                                                                   tcAPIException,
                                                                   tcAttributeNotFoundException,
                                                                   tcAPIException

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. The proxy functionality will have no effect on the results of this API method.

Parameters:: userKey -; attributeList -
Returns:
Throws:: 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.
Since:: 8.0
See Also:: getApprovalTasksAssignedToUser

reassignApprovalTasksToUser

void reassignApprovalTasksToUser(long[] taskInstanceKeys,
                                 long userKey)
                                 throws tcAPIException,
                                        tcUserNotFoundException,
                                        tcTaskNotFoundException,
                                        tcBulkException,
                                        tcAPIException

This method re-assigns the selected approval tasks to the specified user.

Parameters:: taskInstanceKeys - array of task instances that need to be re-assigned; userKey - the user key that all the task instance will re-assign to
Throws:: tcAPIException - 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.
Since:: 8.0

reassignApprovalTasksToGroup

void reassignApprovalTasksToGroup(long[] taskInstanceKeys,
                                  long groupKey)
                                  throws tcAPIException,
                                         tcGroupNotFoundException,
                                         tcTaskNotFoundException,
                                         tcBulkException,
                                         tcAPIException

This method re-assigns the selected approval tasks to the specified group.

Parameters:: taskInstanceKeys - array of task instances that need to be re-assigned; groupKey - the group key that all the task instance will re-assign to
Throws:: tcAPIException - 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.
Since:: 8.0

getNumberOfRequestsCreatedForUser

int getNumberOfRequestsCreatedForUser(long userKey,
                                      boolean pending)
                                      throws tcUserNotFoundException,
                                             tcAPIException,
                                             tcAPIException

Returns the number of requests that have been created for a specific user.

Parameters:

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:

Request Initialized
Not Approved
Request Complete
Request Closed
Request Cancelled

False indicates to show all requests created for the specified user without filtering.

Returns:

An integer representing the number of requests.

Throws:

tcUserNotFoundException

tcAPIException

Since:

8.0

getNumberOfRequestsCreatedByUser

int getNumberOfRequestsCreatedByUser(long userKey,
                                     boolean pending)
                                     throws tcUserNotFoundException,
                                            tcAPIException,
                                            tcAPIException

Returns the number of requests that have been created by a specific user.

Parameters:

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:

Request Initialized
Not Approved
Request Complete
Request Closed
Request Cancelled

False indicates to show all requests created by the specified user without filtering.

Returns:

An integer representing the number of requests.

Throws:

tcUserNotFoundException

tcAPIException

Since:

8.0

getNumberOfPendingRequests

long getNumberOfPendingRequests(long userKey)
                                throws tcUserNotFoundException,
                                       tcAPIException,
                                       tcAPIException

Returns the number of pending requests given a user key

Parameters:: userKey - the user to retrieve the pending approvals for
Throws:: tcUserNotFoundException; tcAPIException

initiateRequestApproval

void initiateRequestApproval(long reqKey)
                             throws tcInvalidStatusException,
                                    tcAPIException,
                                    tcAPIException

Initiates the request approval(Standard Approval) process

Parameters:: reqKey - the request to initiate the approval process
Throws:: tcInvalidStatusException; tcAPIException

getProvisioningDetail

Thor.API.tcResultSet getProvisioningDetail(long requestID)
                                           throws tcAPIException,
                                                  tcAPIException

This method returns all provisioning information for the reqeust.

Parameters:: reqeustID - the request key for the request
Returns:: tcResultSet
Throws:: tcAPIException - raise if a problem occurred when retrieving the information.
Since:: 8.0

getPendingApprovals

Thor.API.tcResultSet getPendingApprovals(long requestID)
                                         throws tcAPIException,
                                                tcAPIException

Deprecated.

This method returns all pendig approvals for the request.

Parameters:: reqeustID - the request key for the request
Returns:: tcResultSet
Throws:: tcAPIException - raise if a problem occurred when retrieving the information.
Since:: 8.0

findObjects

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

This method returns all Resource Objects based on the parameters.

Parameters:: actionType - Enable/Disable/Revoke; targetKeys - string array to hold either user keys or organization keys; type - U is user type, O is organization type.; statusesIn - A string array that specifies the statuses of the objects to be returned; statusesNotIn - 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.
Returns:: tcResultSet
Throws:: tcAPIException - raise if a problem occurred when retrieving the information.
Since:: 9.0.1.2

findObjects

Thor.API.tcResultSet findObjects(java.lang.String actionType,
                                 java.lang.String[] targetKeys,
                                 java.lang.String type,
                                 java.util.Map searchCriteria)
                                 throws tcAPIException,
                                        tcAPIException

This method returns all Resource Objects based on the parameters.

Parameters:: actionType - Enable/Disable/Revoke; targetKeys - string array to hold either user keys or organization keys; type - U is user type, O is organization type.; searchCriteria. - Object name and value pair need to be passed in.
Returns:: tcResultSet
Throws:: tcAPIException - raise if a problem occurred when retrieving the information.
Since:: 8.0

removeRequestObject

void removeRequestObject(java.lang.String requestKey,
                         java.lang.String objectInstanceKey)
                         throws tcAPIException,
                                tcRequestNotFoundException,
                                tcRequestObjectInvalidException,
                                tcAPIException

Deletes an Object to be provisioned from a Request

Parameters:: requestKey - The key for the request to remove the object from.; objectInstanceKey - The key of the Object Instance to remove
Throws:: tcAPIException; tcRequestNotFoundException; tcRequestObjectInvalidException

getSelectedResolutionInstances

Thor.API.tcResultSet getSelectedResolutionInstances(java.lang.String requestKey,
                                                    java.lang.String type)
                                                    throws tcAPIException,
                                                           tcAPIException

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.
The values returned here are the ones that will be acted upon when the request enable/disable/revoke action is taken.
This method call only makes sense in the context of a request whose action type is Enable/Disable/Revoke.

Parameters:: requestKey - The Key of the Request.; type - U is for User. O is for Organization
Throws:: tcAPIException
Since:: 8.0

getApprovalTasksAssignedToSubgroups

Thor.API.tcResultSet getApprovalTasksAssignedToSubgroups(long userKey,
                                                         java.util.Map attributeMap,
                                                         boolean hierarchyOrder)
                                                         throws tcAPIException,
                                                                tcUserNotFoundException,
                                                                tcAttributeNotFoundException,
                                                                tcAPIException

This method returns a list of all the pending approval tasks that are visible to the specified user based on his indirect group membership. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set. This method looks at both the standard approval and object approval processes and returns a resultset of a tasks from both.

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

hierarchyOrder - 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.

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

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.

Since:

9.0.1.1.2

getRequestDetail

com.thortech.xl.vo.RequestDetail getRequestDetail(java.lang.String requestKey,
                                                  java.lang.String requestID)
                                                  throws tcAPIException

Returns all the request detail by request key

Parameters:: plRequstKey - The request Key for the request
Returns:: A RequestDetail about the request
Throws:: tcAPIException

getPendingApprovalTasksAssignedToUser

Thor.API.tcResultSet getPendingApprovalTasksAssignedToUser(long userKey,
                                                           java.util.Map attributeList)
                                                           throws tcUserNotFoundException,
                                                                  tcAPIException,
                                                                  tcAttributeNotFoundException,
                                                                  tcAPIException

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

9.1

getPendingApprovalTasksAssignedToUserPaged

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

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

startRow - The starting row of the result

pageSize - 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 descending

getTotalRowCount - - a boolean value if the get total number of rows along with paged results

Returns:

tcResultSet with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

9.1.0.1

getCountOfPendingApprovalTasksAssignedToUser

int getCountOfPendingApprovalTasksAssignedToUser(long userKey,
                                                 java.util.Map attributeList)
                                                 throws tcUserNotFoundException,
                                                        tcAPIException,
                                                        tcAttributeNotFoundException,
                                                        tcAPIException

This method returns a number of pending approval tasks that are assigned to the specified user. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set. This method returns tasks not only assigned to the user passed in as a parameter, but also the users who assigned the passed-in-user as a proxy. The same thing applies to groups as well.This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:: userKey - the user key to find the approval tasks; attributeList - the list of attributes that filter the search of approval tasks
Returns:: int - number of pending approvals.
Throws:: tcUserNotFoundException - 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.
Since:: 9.1.0.1

getPendingApprovalTasksAssigned

Thor.API.tcResultSet getPendingApprovalTasksAssigned(java.util.Map attributeList)
                                                     throws tcAPIException,
                                                            tcAttributeNotFoundException,
                                                            tcAPIException

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

9.1

getPendingApprovalTasksAssignedToManagedUsers

Thor.API.tcResultSet getPendingApprovalTasksAssignedToManagedUsers(long userKey,
                                                                   java.util.Map attributeList)
                                                                   throws tcUserNotFoundException,
                                                                          tcAPIException,
                                                                          tcAttributeNotFoundException,
                                                                          tcAPIException

Parameters:: userKey -; attributeList -
Returns:
Throws:: 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.
Since:: 9.1
See Also:: getPendingApprovalTasksAssignedToUser

getPendingApprovalTasksAssignedToManagedUsersPaged

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

This method returns a list of all the pending approval tasks that are assigned to the users managed by a specific user. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set. This method returns tasks not only assigned to the user passed in as a parameter, but also the users who assigned the passed-in-user as a proxy. The same thing applies to groups as well. This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

startRow - The starting row of the result

pageSize - 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 descending

Returns:

tcResultSet with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requester.User ID
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Consolidated Data Value
Requests.Object Request Type
Process Instance.Task Details.Key
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Status.Category
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Details.Task Offlined
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

9.1.0.1

getNumberOfPendingRequestsAssignedToUser

long getNumberOfPendingRequestsAssignedToUser(long userKey)
                                              throws tcUserNotFoundException,
                                                     tcAPIException,
                                                     tcAPIException

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

Parameters:: userKey - the user to retrieve the pending approvals for
Throws:: tcUserNotFoundException; tcAPIException
Since:: 9.1

getNumberOfPendingApprovalTasksAssignedToUser

int getNumberOfPendingApprovalTasksAssignedToUser(long userKey)
                                                  throws tcUserNotFoundException,
                                                         tcAPIException,
                                                         tcAPIException

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

Parameters:: userKey - The User Key of the user for whom to get the number of approval tasks.
Throws:: 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.
Since:: 9.1

getPendingApprovalTasksAssignedToSubgroups

Thor.API.tcResultSet getPendingApprovalTasksAssignedToSubgroups(long userKey,
                                                                java.util.Map attributeMap,
                                                                boolean hierarchyOrder)
                                                                throws tcAPIException,
                                                                       tcUserNotFoundException,
                                                                       tcAttributeNotFoundException,
                                                                       tcAPIException

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Object Request Type
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

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.

Since:

9.1

getGenericFindRequest

Thor.API.tcResultSet getGenericFindRequest(java.util.Map searchCriteria)
                                           throws tcAPIException,
                                                  tcUserNotFoundException,
                                                  tcObjectNotFoundException,
                                                  tcAPIException

Returns a list of requests (in the form of a tcResultSet) made for the specified user. It also can narrow down the requests by the status.

Parameters:: searchCriteria. - Object name and value pair need to be passed in.
Returns:: A tcResultSet in which each row holds information about the request
Throws:: tcAPIException; tcUserNotFoundException; tcObjectNotFoundException
Since:: 9.2

getPendingApprovalTasksAssignedToSubgroupsPaged

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

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of approval tasks

startRow - The starting row of the result

pageSize - 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 descending

getTotalRowCount - - a boolean value which specifies whether to get total number of rows along with paged results

Returns:

tcResultSet with the information matching the filter criteria. The following are the columns returned:

Requester.First Name
Requester.Last Name
Requester.User ID
Requests.Key
Requests.Request ID
Requests.Row Version
Requests.Type
Requests.Consolidated Data Value
Requests.Object Request Type
Process Instance.Task Details.Key
Process Instance.Task Details.Row Version
Process Instance.Task Details.Status
Status.Category
Process Instance.Task Details.Type
Process Instance.Task Details.Update Date
Process Instance.Task Details.Update By
Process Instance.Task Details.Action
Process Instance.Task Details.Actual End Date
Process Instance.Task Details.Actual Start Date
Process Instance.Task Details.Created By
Process Instance.Task Details.Creation Date
Process Instance.Task Details.Projected End
Process Instance.Task Details.Projected Start
Process Instance.Task Details.Task Offlined
Process Instance.Task Information.Assigned To
Process Instance.Task Information.Assigned To User Key
Process Instance.Task Information.Created By
Process Instance.Task Information.Creation Date
Process Instance.Task Information.Retry Task
Process Instance.Task Information.Row Version
Process Instance.Task Information.Update Date
Process Instance.Task Information.Updated By
Process Instance.Task Information.Assigned To Group Key
Process Instance.Task Information.Assigned Type
Process Instance.Task Information.Assignee User ID
Process Instance.Task Information.Assignee First Name
Process Instance.Task Information.Assignee Last Name
Groups.Group Name
Process Definition.Tasks.Task Name
Objects.Name

Throws:

tcUserNotFoundException - 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.

Since:

9.1.0.1

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Thor.API.Operations Interface tcRequestOperationsIntf

findRequests

findRequests

findRequests

findRequests

findRequests

findRequestsByDate

findRequestsAfterDate

findRequestsBeforeDate

findRequestsByStatusDate

findRequestsByStatusAfterDate

findRequestsByStatusBeforeDate

getRequestsForObject

getRequestsForUserTarget

getRequestsForUserTarget

getRequestsForUserTarget

getNumberOfRequestsCreatedByUser

getNumberOfRequestsForTargetUser

getRequestsForOrganizationTarget

getRequestsAssignedForApproval

getRequestsAssignedForApproval

getRequestsAssignedForApproval

getRequestTargetsForAdditionalFeilds

getRequestTargets

getRequestObjects

isResourceApprovable

getRequestComments

getRequestAdministrativeGroups

getRequestStatusHistory

getRequestObjectStatusHistory

getRequestObjectTargetInstanceKeys

createProfileModifyRequest

createRequest

completeRequestCreation

updateRequest

cancelRequest

cancelRequest

closeRequest

addRequestObjects

addRequestObject

addRequestObject

setRequestObjectAsServiceAccountFlag

removeRequestObject

canTriggerObject

triggerRequestObject

addRequestUser

removeRequestUser

addRequestOrganization

removeRequestOrganization

addRequestComment

addAdministrativeGroup

updateAdministrativeGroup

removeAdministrativeGroup

assignRequestToUser

isRequestCancellable

isRequestUpdatable

isRequestApprovable

getRequestRoles

getRequestResponses

setRequestResponse

requestMoreInfoFromUser

requestMoreInfoFromUserWithComment

requestMoreInfoFromUserForResource

requestMoreInfoFromUserWithCommentForResource

requestMoreInfoFromGroup

requestMoreInfoFromGroupWithComment

getRequestTypes

getRequestStages

getRequestsForQueue

getRequestsForQueueByStatus

getQueuesForRequest

assignQueue

removeQueue

assignRequestObjectToQueue

removeRequestObjectFromQueue

assignRequestObjectToQueueAdmin

getRequestsForAuthorization

requiresInstanceResolution

getInstanceResolutionListForUser

getInstanceResolutionListForOrg

Thor.API.Operations
Interface tcRequestOperationsIntf