tcProvisioningOperationsIntf (Thor.API.Operations Javadoc)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Thor.API.Operations
Interface tcProvisioningOperationsIntf

public interface tcProvisioningOperationsIntf

Method Summary
`void`	`addProcessTaskInstance(long plTaskKey, long plOrcKey)` Provides the ability to add/execute a task where the task's manual insert property is enabled.
`long`	`createObjectInstanceWithObjectAndChildFormData(long plTargetKey, long plObjectKey, java.util.Map mhMap, java.util.Map childMap)` Updates the details of a specified task instance.
`long`	`createObjectInstanceWithObjectFormData(long plTargetKey, long plObjectKey, java.util.Map mhMap)` Creates resource instance along with the resource data.
`Thor.API.tcResultSet`	`getApprovalProcessInformation(long plObjectInstanceKey)` Returns information about the approval process associated with an object instance in the system.
`Thor.API.tcResultSet`	`getAssignedProvisioningTasks(long userKey, java.util.Map attributeList, java.lang.String[] statuses)` This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to.
`int`	`getNumberOfProvisioningTasksAssignedToUser(long userKey, java.lang.String[] statuses)` This method returns the number of provisioning tasks are assigned to a given user based on the given statuses.
`Thor.API.tcResultSet`	`getOrganizationProvisioningProcessInformation(long plObjectInstanceForOrganizationKey)` Returns information about the provisioning process associated with an object instance for an organization in the system.
`Thor.API.tcResultSet`	`getProcessDetail(long plProcessInstanceKey)` Returns detailed task information about the process specified.
`java.util.Date`	`getProvisioingProcessOfflinedDate(long processInstanceKey)` API to find out if a given provisioned instance for a user is in off-lined stage or not
`Thor.API.tcResultSet`	`getProvisioningTaskDetails(long taskInstanceKey)` Returns information about the provisioning process task instance.
`Thor.API.tcResultSet`	`getProvisioningTasksAssignedToManagedUsers(long userKey, java.util.Map attributeList, java.lang.String[] statuses)` This method returns a list of all the provisioning tasks (and their details) that are assigned to the users for whom the specified user is a manager of.
`Thor.API.tcResultSet`	`getResponsesForInstanceTask(long instanceKey)` This method returns all the responses for a given a task instance.
`Thor.API.tcResultSet`	`getUserProvisioningProcessInformation(long plObjectInstanceForUserKey)` Returns information about the provisioning process associated with an object instance for a user in the system.
`boolean`	`isTaskUpdatable(long plTaskInstanceKey, long plUserKey)` Verifies if the user has the permission to updates the details of a specified task instance.
`void`	`reassignTasksToGroup(long[] taskInstanceKeys, long groupKey)` This method re-assigns the selected provisioning tasks to the specified group.
`void`	`reassignTasksToUser(long[] taskInstanceKeys, long userKey)` This method re-assigns the selected tasks to the specified user.
`java.lang.String`	`retryTask(long plTaskInstanceKey)` Provides the ability to re-execute a task if any of its prior executions have failed.
`java.util.Map`	`retryTasks(long[] taskInstanceKeys)` This method provides the ability to re-execute the list of specified tasks if any of their prior executions have failed.
`void`	`setTasksCompletedManually(long[] taskInstanceKeys)` This method provides the ability to set the task instance as manually completed given a list of specified tasks.
`void`	`updateTask(long plTaskInstanceKey, java.util.Map phAttributeList)` Updates the details of a specified task instance.

Method Detail

getUserProvisioningProcessInformation

public Thor.API.tcResultSet getUserProvisioningProcessInformation(long plObjectInstanceForUserKey)
                                                           throws Thor.API.Exceptions.tcAPIException,
                                                                  Thor.API.Exceptions.tcNotProvisionedException,
                                                                  tcAPIException

Returns information about the provisioning process associated with an object instance for a user in the system. It locates the provisioning process, and returns a result set giving information about the provisioning process. If the provisioning process is a meta-process, it returns within the result set information about all the sub-processes involved in provisioning. The information provided is enough to recreate the process tree.

Parameters:: plObjectInstanceForUserKey - The key of the object instance for a user in the system.
Returns:: A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information
Throws:: tcAPIException; tcNotProvisionedException

getOrganizationProvisioningProcessInformation

public Thor.API.tcResultSet getOrganizationProvisioningProcessInformation(long plObjectInstanceForOrganizationKey)
                                                                   throws Thor.API.Exceptions.tcAPIException,
                                                                          Thor.API.Exceptions.tcNotProvisionedException,
                                                                          tcAPIException

Returns information about the provisioning process associated with an object instance for an organization in the system. It locates the provisioning process, and returns a result set giving information about the provisioning process. If the provisioning process is a meta-process, it returns within the result set information about all the sub-processes involved in provisioning. The information provided is enough to recreate the process tree.

Parameters:: plObjectInstanceForOrganizationKey - The key of the object instance for an organization in the system.
Returns:: A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information
Throws:: tcAPIException; tcNotProvisionedException

getApprovalProcessInformation

public Thor.API.tcResultSet getApprovalProcessInformation(long plObjectInstanceKey)
                                                   throws Thor.API.Exceptions.tcAPIException,
                                                          Thor.API.Exceptions.tcNoApprovalException,
                                                          tcAPIException

Returns information about the approval process associated with an object instance in the system. It locates the approval process, and returns a result set giving information about it. If the approval process is a meta-process, it returns within the result set information about all the sub-processes involved in provisioning. The information provided is enough to recreate the process tree.

Parameters:: plObjectInstanceKey - The key of the object instance in the system.
Returns:: A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information
Throws:: tcAPIException; tcNoApprovalException

getProcessDetail

public Thor.API.tcResultSet getProcessDetail(long plProcessInstanceKey)
                                      throws Thor.API.Exceptions.tcAPIException,
                                             Thor.API.Exceptions.tcNotAtomicProcessException,
                                             tcAPIException

Returns detailed task information about the process specified. This detail covers all the tasks involved in the process, their current statuses and other such detailed information. It should only be used with atomic processes.

Parameters:: plProcessInstanceKey - The key of the process instance in the system.
Returns:: A tcResultSet containing one to many rows, each row holding information about a task in the process.
Throws:: tcAPIException; tcNotAtomicProcessException

addProcessTaskInstance

public void addProcessTaskInstance(long plTaskKey,
                                   long plOrcKey)
                            throws Thor.API.Exceptions.tcTaskNotFoundException,
                                   Thor.API.Exceptions.tcAPIException,
                                   tcAPIException

Provides the ability to add/execute a task where the task's manual insert property is enabled. If an instance of this task already exists, the task must have 'Allow Multiple Instances' property set to true in order to be executed.

Parameters:: plTaskKey - The key of the process task defined in process definition; plOrcKey - The key of the process order instance
Throws:: tcTaskNotFoundException - thrown when the task key passed is invalid; tcAPIException - thrown if any errors occur while adding the task instance

retryTask

public java.lang.String retryTask(long plTaskInstanceKey)
                           throws Thor.API.Exceptions.tcTaskNotFoundException,
                                  Thor.API.Exceptions.tcAPIException,
                                  tcAPIException

Provides the ability to re-execute a task if any of its prior executions have failed.

Parameters:: plTaskInstanceKey - The key of the task instance to be re-executed
Returns:: Status of the task instance after it's been re-executed
Throws:: tcTaskNotFoundException; tcAPIException

updateTask

public void updateTask(long plTaskInstanceKey,
                       java.util.Map phAttributeList)
                throws Thor.API.Exceptions.tcTaskNotFoundException,
                       Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcAwaitingObjectDataCompletionException,
                       Thor.API.Exceptions.tcAwaitingApprovalDataCompletionException,
                       tcAPIException

Updates the details of a specified task instance.

Parameters:

plTaskInstanceKey - The key of the task instance to be updated

phAttributeList - A Map of name-value pairs. The Map key should contain the following metadata codes:

Process Instance.Task Details.Note
Process Instance.Task Details.Status
Process Instance.Task Information.Assigned To User Key

The Map value should contain the respective update data.

Throws:

tcTaskNotFoundException

tcAPIException

tcAwaitingObjectDataCompletionException

tcAwaitingApprovalDataCompletionException

isTaskUpdatable

public boolean isTaskUpdatable(long plTaskInstanceKey,
                               long plUserKey)
                        throws Thor.API.Exceptions.tcTaskNotFoundException,
                               Thor.API.Exceptions.tcAPIException,
                               tcAPIException

Verifies if the user has the permission to updates the details of a specified task instance.

Parameters:: plTaskInstanceKey - The key of the task instance to be updated; plUserKey - The key of user whose permissions need to be checked.
Returns:: boolean If the task is assigned to the user a true value is returned.
Throws:: tcTaskNotFoundException; tcAPIException

getProvisioningTaskDetails

public Thor.API.tcResultSet getProvisioningTaskDetails(long taskInstanceKey)
                                                throws Thor.API.Exceptions.tcAPIException,
                                                       tcAPIException

Returns information about the provisioning process task instance.

Parameters:: taskInstanceKey - The key of the task instance for a provisioning process.
Returns:: A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information
Throws:: tcAPIException; tcNotProvisionedException

getAssignedProvisioningTasks

public Thor.API.tcResultSet getAssignedProvisioningTasks(long userKey,
                                                         java.util.Map attributeList,
                                                         java.lang.String[] statuses)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.tcUserNotFoundException,
                                                         Thor.API.Exceptions.tcAttributeNotFoundException,
                                                         tcAPIException

This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object will be a result set with each row having detail information of each task. The returned result set also contains a column mentioning whether the specified user can see the task because he/she is a proxy for some other user. Also, it should returned a new column called "Date Assigned" which will have the date when the task was assigned to the user/group.

Parameters:: userKey - User to get the assigned provisioning tasks.; attributeList - List of attributes to filter the requested information.; statuses - an array of status strings to filter the result set
Returns:
Throws:: tcAPIException - raise if a problem occurred in the API; tcUserNotFoundException - raise if the user is not valid; tcAttributeNotFoundException - raise if an attribute is not valid
Since:: 8.0

getProvisioningTasksAssignedToManagedUsers

public Thor.API.tcResultSet getProvisioningTasksAssignedToManagedUsers(long userKey,
                                                                       java.util.Map attributeList,
                                                                       java.lang.String[] statuses)
                                                                throws Thor.API.Exceptions.tcAPIException,
                                                                       Thor.API.Exceptions.tcUserNotFoundException,
                                                                       Thor.API.Exceptions.tcAttributeNotFoundException,
                                                                       tcAPIException

This method returns a list of all the provisioning tasks (and their details) that are assigned to the users for whom the specified user is a manager of. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object is a result set with each row having detail information of each task. The result set also contain a column mentioning whether the specified user is a proxy for the user. Also, this method returnes a new column called "Date Assigned" which will have the date when the task was assigned to the user/group. The method also includes a Map as an argument that will contain name-value pairs so that the result set can be filtered over multiple columns. The attribute list should support the date search feature so that the tasks can be searched with start and end date ranges.

Parameters:: userKey - User to get the assigned provisioning tasks.; attributeList - List of attributes to filter the requested information.; statuses - an array of status strings to filter the result set
Returns:: a result set with provisiong task information
Throws:: tcAPIException - raise if a problem occurred in the API; tcUserNotFoundException - raise if the user is not valid; tcAttributeNotFoundException - raise if an attribute is not valid
Since:: 8.0

reassignTasksToUser

public void reassignTasksToUser(long[] taskInstanceKeys,
                                long userKey)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcUserNotFoundException,
                                Thor.API.Exceptions.tcTaskNotFoundException,
                                Thor.API.Exceptions.tcBulkException,
                                tcAPIException

This method re-assigns the selected 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

reassignTasksToGroup

public void reassignTasksToGroup(long[] taskInstanceKeys,
                                 long groupKey)
                          throws Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                 Thor.API.Exceptions.tcTaskNotFoundException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

This method re-assigns the selected provisioning 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

retryTasks

public java.util.Map retryTasks(long[] taskInstanceKeys)
                         throws Thor.API.Exceptions.tcTaskNotFoundException,
                                Thor.API.Exceptions.tcBulkException,
                                Thor.API.Exceptions.tcAPIException,
                                tcAPIException

This method provides the ability to re-execute the list of specified tasks if any of their prior executions have failed.

Parameters:: taskInstanceKeys - array of task instances to retry
Returns:: a Map of keys and status of the retry of each of the instances.
Throws:: tcTaskNotFoundException - raised if one or more task instances are not valid. isMessage will contain the list of invalid task instance keys separated by commas.; tcBulkException - raised if one or many task instance had errors retrying. getReturnValue() from this exception returns a Map of successfully retried tasks and isKeys is an array of task which retry caused problems.; tcAPIException - raise if a problem occurred when retrying the task.
Since:: 8.0

getNumberOfProvisioningTasksAssignedToUser

public int getNumberOfProvisioningTasksAssignedToUser(long userKey,
                                                      java.lang.String[] statuses)
                                               throws Thor.API.Exceptions.tcUserNotFoundException,
                                                      Thor.API.Exceptions.tcAPIException,
                                                      tcAPIException

This method returns the number of provisioning tasks are assigned to a given user 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

setTasksCompletedManually

public void setTasksCompletedManually(long[] taskInstanceKeys)
                               throws Thor.API.Exceptions.tcTaskNotFoundException,
                                      Thor.API.Exceptions.tcBulkException,
                                      Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

This method provides the ability to set the task instance as manually completed given a list of specified tasks.

Parameters:: taskInstanceKeys - array of task instances to retry
Throws:: tcTaskNotFoundException - raised if one or more task instances are not valid. isMessage will contain the list of invalid task instance keys separated by commas.; tcBulkException - raised if one or many task instance had errors retrying.; tcAPIException - raise if a problem occurred when retrying the task.
Since:: 8.0

createObjectInstanceWithObjectFormData

public long createObjectInstanceWithObjectFormData(long plTargetKey,
                                                   long plObjectKey,
                                                   java.util.Map mhMap)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   tcAPIException

Creates resource instance along with the resource data.

Parameters:: plTargetKey - either user key or organization key.; plObjectKey - resource instance key.; mhMap - form data.
Returns:: long
Throws:: tcAPIException
Since:: 8.0

createObjectInstanceWithObjectAndChildFormData

public long createObjectInstanceWithObjectAndChildFormData(long plTargetKey,
                                                           long plObjectKey,
                                                           java.util.Map mhMap,
                                                           java.util.Map childMap)
                                                    throws Thor.API.Exceptions.tcAPIException,
                                                           tcAPIException