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 AttestationOperationsIntf

public interface AttestationOperationsIntf

Method Summary
 void attestTask(long attestationTaskKey)
          This API attests the specified task and initiates any work flow setup.
 Thor.API.tcResultSet getAttestationProcessExecutionHistory(long processDefKey)
          Returns all the attestation requests created for a given attestation process.
 Thor.API.tcResultSet getAttestationRecordDelegatedPath(long recordKey)
          Returns all the delegation that occurred for a specific record
 Thor.API.tcResultSet getAttestationRequestDetails(long attestationRequestKey, java.util.Map attributes, int startRow, int pageSize)
          Returns the attestation records associated with an attestation request.
 com.thortech.xl.vo.UDFormData getEntitlementRecordDetails(long recordKey)
          Returns the process form data given a record key.
 Thor.API.tcResultSet getOwnerAttestationProcesses()
          Returns the attestation processes that are owned by the groups the logged in user is member of.
 Thor.API.tcResultSet getPendingAttestationTasks(long userKey)
          Returns all the pending attestation tasks assigned to the specified user
 Thor.API.tcResultSet getRequestDetailsForDashBoard(long attestationRequestKey, java.util.Map attributes, int startRow, int pageSize)
          Returns the attestation records associated with an attestation request.
 void initiateAttestationProcess(java.lang.String processName)
          Initiates the specified attestation process by creating the attestation tasks
 void submitReponses(long attestationTaskKey, com.thortech.xl.vo.AttestationItemResponse[] responses, java.lang.String defaultDelegate, java.lang.String defalutComment)
          Submits the specified responses on the records of a attestation task
 

Method Detail

initiateAttestationProcess

public void initiateAttestationProcess(java.lang.String processName)
                                throws Thor.API.Exceptions.tcAPIException,
                                       Thor.API.Exceptions.tcInvalidPermissionsException,
                                       Thor.API.Exceptions.AttestationProcessNotFoundException,
                                       tcAPIException
Initiates the specified attestation process by creating the attestation tasks

Throws:
AttestationProcessNotFoundException, - If the specified attestation process name does not exist
tcAPIException, - If an error occurs while querying or creating attestation requests
tcInvalidPermissionsException, - If the process is not instantiated by scheduler or process owner
Thor.API.Exceptions.tcAPIException
Thor.API.Exceptions.tcInvalidPermissionsException
Thor.API.Exceptions.AttestationProcessNotFoundException

submitReponses

public void submitReponses(long attestationTaskKey,
                           com.thortech.xl.vo.AttestationItemResponse[] responses,
                           java.lang.String defaultDelegate,
                           java.lang.String defalutComment)
                    throws Thor.API.Exceptions.TaskAlreadyAttestedException,
                           Thor.API.Exceptions.tcAPIException,
                           Thor.API.Exceptions.tcInvalidPermissionsException,
                           Thor.API.Exceptions.UnknownAttestationRecordResponse,
                           tcAPIException
Submits the specified responses on the records of a attestation task

Throws:
TaskAlreadyAttestedException, - If responses for all the records are already provided and task is already sumbmitted for attestation
tcAPIException, - If any of the records do not belong to the spcified attestation task or user to delegate is not specified for one or more attestation records where the response specified is delegate
tcInvalidPermissionsException, - if the logged in user is not same as the attestation task reviewer
UnknownAttestationRecordResponse, - If responses provided for one or more records is not Certify/Reject/Decline/Delegate
Thor.API.Exceptions.TaskAlreadyAttestedException
Thor.API.Exceptions.tcAPIException
Thor.API.Exceptions.tcInvalidPermissionsException
Thor.API.Exceptions.UnknownAttestationRecordResponse

attestTask

public void attestTask(long attestationTaskKey)
                throws Thor.API.Exceptions.MissingResponsesException,
                       Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcInvalidPermissionsException,
                       tcAPIException
This API attests the specified task and initiates any work flow setup. This should be called after responses responses are provided to all the records in the attestation task

Throws:
MissingResponsesException, - If response is not provided to one or more records in the task
tcAPIException, - If an error occurs while querying for the data
tcInvalidPermissionsException, - if the logged in user is not same as the attestation task reviewer
Thor.API.Exceptions.MissingResponsesException
Thor.API.Exceptions.tcAPIException
Thor.API.Exceptions.tcInvalidPermissionsException

getPendingAttestationTasks

public Thor.API.tcResultSet getPendingAttestationTasks(long userKey)
                                                throws Thor.API.Exceptions.tcAPIException,
                                                       tcAPIException
Returns all the pending attestation tasks assigned to the specified user

Returns:
A tcResultSet that contains the following information:
  • Attestation Definition.Key, Key of the attestation process that generated the task
  • Attestation Definition.Process Name, Name of the attestation process that generated the task
  • Attestation Definition.Process Code, Code of the attestation process that gerenated the task
  • Attestation Requests.Scope Type, Attestation process scope type
  • Attestation Tasks.Delegated By, Key of the delegator if the task is delegated
  • Attestation Task.Delegator User Id , Login of the delegator user if the task is delegated
  • Attestation Task.Delegator First Name , First Name of the delegator if the task is delegated
  • Attestation Task.Delegator Last Name, Last name of the delegaor if the task is delegated
  • Attestation Requests.Execution Time, Date and time at which the task created
  • Attestation Requests.Key, Attestation request key form which the task belongs to
  • Attestation Tasks.Key , Attestation Task Key
Throws:
tcAPIException, - If an error occurs while retrieving the task data
Thor.API.Exceptions.tcAPIException

getEntitlementRecordDetails

public com.thortech.xl.vo.UDFormData getEntitlementRecordDetails(long recordKey)
                                                          throws Thor.API.Exceptions.tcAPIException,
                                                                 tcAPIException
Returns the process form data given a record key.

Returns:
A value object containing the process form data at the time the attestation record is created
Throws:
tcAPIException, - If an error occurs while retrieving the data
Thor.API.Exceptions.tcAPIException

getAttestationRequestDetails

public Thor.API.tcResultSet getAttestationRequestDetails(long attestationRequestKey,
                                                         java.util.Map attributes,
                                                         int startRow,
                                                         int pageSize)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         tcAPIException
Returns the attestation records associated with an attestation request. Results are sorted by the following columns in the order Attestation Tasks.Reviewer, Provisioned User.Key, Objects.Key

Returns:
A tcResultSet that contains the following information:
  • Attestation Tasks.Key , Attestation Task for which the current record belongs to
  • Provisioned User.Key, key of user whose provisioned resource instance being attested
  • Provisioned User.First Name, First Name of user whose provisioned resource instance being attested
  • Provisioned User.Last Name, Last Name of user whose provisioned resource instance being attested
  • Provisioned User.User Id, Login of user whose provisioned resource instance being attested
  • Process Instance.Descriptive Data, The descriptive data field for the provisioned resource instance
  • Users-Object Instance For User.Last Attested By, Key of the user who last attested this provisioned resource instance
  • Users-Object Instance For User.Last Attested On, Date and Time at which this provisioned resource instance is last attested
  • Attestation Data.Record Comment, Comments provided by the reviewer for the record
  • Attestation Data.Record Status, Status of the record
  • Attestation Data.Record Response, Response provided by the reviewer for the current record
  • Objects.Key, Key of the resource object
  • Objects.Name, Name of the resource object that is basis for current record
  • Attestation Data.Record Delegated To, Key of the user for whom the record is delegated to if the record is delegated
  • Delegated User.First Name, First Name of the user for whom the record is delegated to if the record is delegated
  • Delegated User.Last Name, Last Name of the user for whom the record is delegated to if the record is delegated
  • Delegated User.User Id, Login of the user for whom the record is deletaed to if the record is delegated
  • Attestation Tasks.Reviewer, Key of the user for whom the attestation task is assigned where the current record is part of
  • Reviewer.First Name, First Name of the user for whom the attestation task is assigned where the current record is part of
  • Reviewer.Last Name, Last Name of the user for whom the attestation task is assigned where the current record is part of
  • Reviewer.User Id, Login of the user for whom the attestation task is assigned where the current record is part of
  • User Profile Audit.Key, Key to provisioned user profile information at the time attestation task is created.
  • Attestation Data.Record Key, Record Key
Throws:
tcAPIException, - If an error occurs while retrieving the data
Thor.API.Exceptions.tcAPIException

getRequestDetailsForDashBoard

public Thor.API.tcResultSet getRequestDetailsForDashBoard(long attestationRequestKey,
                                                          java.util.Map attributes,
                                                          int startRow,
                                                          int pageSize)
                                                   throws Thor.API.Exceptions.tcAPIException,
                                                          tcAPIException
Returns the attestation records associated with an attestation request. Results are sorted by the following columns in the order Attestation Tasks.Reviewer, Provisioned User.Key, Objects.Key This API returns responses for only the records that are submitted and returns null otherwise This also filters all the submitted records where the response id 'Delegate'

Returns:
A tcResultSet that contains the following information:
  • Attestation Tasks.Key , Attestation Task for which the current record belongs to
  • Provisioned User.Key, key of user whose provisioned resource instance being attested
  • Provisioned User.First Name, First Name of user whose provisioned resource instance being attested
  • Provisioned User.Last Name, Last Name of user whose provisioned resource instance being attested
  • Provisioned User.User Id, Login of user whose provisioned resource instance being attested
  • Process Instance.Descriptive Data, The descriptive data field for the provisioned resource instance
  • Users-Object Instance For User.Last Attested By, Key of the user who last attested this provisioned resource instance
  • Users-Object Instance For User.Last Attested On, Date and Time at which this provisioned resource instance is last attested
  • Attestation Data.Record Comment, Comments provided by the reviewer for the record
  • Attestation Data.Record Status, Status of the record
  • Attestation Data.Record Response, Response provided by the reviewer for the current record if corresponding task is submitted. Null, otherwise
  • Objects.Key, Key of the resource object
  • Objects.Name, Name of the resource object that is basis for current record
  • Attestation Data.Record Delegated To, Key of the user for whom the record is delegated to if the record is delegated
  • Delegated User.First Name, First Name of the user for whom the record is delegated to if the record is delegated
  • Delegated User.Last Name, Last Name of the user for whom the record is delegated to if the record is delegated
  • Delegated User.User Id, Login of the user for whom the record is deletaed to if the record is delegated
  • Attestation Tasks.Reviewer, Key of the user for whom the attestation task is assigned where the current record is part of
  • Reviewer.First Name, First Name of the user for whom the attestation task is assigned where the current record is part of
  • Reviewer.Last Name, Last Name of the user for whom the attestation task is assigned where the current record is part of
  • Reviewer.User Id, Login of the user for whom the attestation task is assigned where the current record is part of
  • User Profile Audit.Key, Key to provisioned user profile information at the time attestation task is created.
  • Attestation Data.Record Key, Record Key
  • Attestation Data.Record Delegated From, Key of the user from whom the record is delegated from if the record is delegated
Throws:
tcAPIException, - If an error occurs while retrieving the data
Thor.API.Exceptions.tcAPIException

getAttestationProcessExecutionHistory

public Thor.API.tcResultSet getAttestationProcessExecutionHistory(long processDefKey)
                                                           throws Thor.API.Exceptions.tcAPIException,
                                                                  Thor.API.Exceptions.AttestationProcessNotFoundException,
                                                                  tcAPIException
Returns all the attestation requests created for a given attestation process.

Returns:
A tcResultSet and returned columns vary based on the attestation scope type.

For the scope type Provisioned Users, the returned columns are
  • Attestation Requests.Key, Attestation request key this instance belongs to
  • Attestation Requests.Scope Type, Scope type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Scope Parameter, Scope parameter defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer Type, Reviewer type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer, Reviewer key defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Execution Time, Date and Time at which the current request is initiated on
  • Attestation Requests.Completion Time, Date and time at which the current request is completed on
  • Objects.Name, Resource object name of the scope parameter value
  • Reviewer.First Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.Last Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.User Id, this column is only populated if the reviewer type is a specific user

For the scope type Group Users, the returned columns are
  • Attestation Requests.Key, Attestation request key this instance belongs to
  • Attestation Requests.Scope Type, Scope type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Scope Parameter, Scope parameter defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer Type, Reviewer type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer, Reviewer key defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Execution Time, Date and Time at which the current request is initiated on
  • Attestation Requests.Completion Time, Date and time at which the current request is completed on
  • Groups.Group Name, Group name of the scope parameter value
  • Reviewer.First Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.Last Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.User Id, this column is only populated if the reviewer type is a specific user

For the scope type Organization Users, the returned columns are
  • Attestation Requests.Key, Attestation request key this instance belongs to
  • Attestation Requests.Scope Type, Scope type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Scope Parameter, Scope parameter defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer Type, Reviewer type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer, Reviewer key defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Execution Time, Date and Time at which the current request is initiated on
  • Attestation Requests.Completion Time, Date and time at which the current request is completed on
  • Organizations.Organization Name, Organization name of the scope parameter value
  • Reviewer.First Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.Last Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.User Id, this column is only populated if the reviewer type is a specific user

For the scope type Managed Users, the returned columns are
  • Attestation Requests.Key, Attestation request key this instance belongs to
  • Attestation Requests.Scope Type, Scope type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Scope Parameter, Scope parameter defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer Type, Reviewer type defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Reviewer, Reviewer key defined for the corresponding attestation process at the time the current instance is run
  • Attestation Requests.Execution Time, Date and Time at which the current request is initiated on
  • Attestation Requests.Completion Time, Date and time at which the current request is completed on
  • Attestation Manager Scope. Manager User Id, Login of the scope parameter value
  • Attestation Manager Scope. Manager First Name, First name of the scope parameter value
  • Attestation Manager Scope. Manager Last Name, Last name of the scope paramater value
  • Reviewer.First Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.Last Name, this column is only populated if the reviewer type is a specific user
  • Reviewer.User Id, this column is only populated if the reviewer type is a specific user

Throws:
tcAPIException - if an error occurs while retrieving the attestation request data
AttestationProcessNotFoundException, - If the specified attestation process key does not exist
Thor.API.Exceptions.AttestationProcessNotFoundException

getAttestationRecordDelegatedPath

public Thor.API.tcResultSet getAttestationRecordDelegatedPath(long recordKey)
                                                       throws Thor.API.Exceptions.tcAPIException,
                                                              Thor.API.Exceptions.AttestationRecordNotDelegatedException,
                                                              tcAPIException
Returns all the delegation that occurred for a specific record

Returns:
A tcResultSet that contains the following information:
  • Attestation Tasks.Reviewer, Key of the user who was assigned the provisioned instance for attestation
  • Reviewer.First Name, First Name of the user who was assigned the provisioned instance for attestation
  • Reviewer.Last Name, Last of the user who was assigned the provisioned instance for attestation
  • Reviewer.User Id, Login of the user who was assigned the provisioned instance for attestation
  • Attestation Tasks.Completion Time, Date and time on which reviewer provided the attestation response
  • Attestation Data.Record Comment, Comments reviewer has provided
  • Attestation Data.Record Response, Response reviewer has provided
  • Attestation Data.Record Delegated To, Key of the user for whom the record is delegated to
  • Attestation Requests.Key, Request Key for which the records belong to
Throws:
tcAPIException, - If an error occurs while getting the delegation path
AttestationRecordNotDelegatedException, - If the specified record is not delegated
Thor.API.Exceptions.tcAPIException
Thor.API.Exceptions.AttestationRecordNotDelegatedException

getOwnerAttestationProcesses

public Thor.API.tcResultSet getOwnerAttestationProcesses()
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         tcAPIException
Returns the attestation processes that are owned by the groups the logged in user is member of. Returns only the processes that are not Disabled or Deleted. Along with process information API also returns information about last request for this process and a request prior to the last one.

Returns:
A tcResultSet that contains the following information:
  • Attestation Definition.Key, Key of the attestation process owned
  • Attestation Definition.Process Name, Name of the attestation process owned
  • Attestation Definition.Process Code, Code of the attestation process owned
  • Attestation Requests.Key, Attestation request key
  • Attestation Requests.Execution Time, Date and time at which the last instance of the process was executed
  • Attestation Requests.Completion Time, Date and time at which last instance execution was completed
  • Attestation Requests.Total Rcords, Total number of provisioned instances identified for attestation and covered by as part of last process instance
  • Attestation Requests.Certified Records, Number of certified records in this last process instance
  • Attestation Requests.Rejected Records, Number of rejected records in this last process instance
  • Attestation Requests.Declined Records, Number of declined records in this last process instance
  • Attestation Requests.Delegated Records, Number of delegated records in this last process instance
  • Attestation Requests.Previous Request Execution Time, Date and Time at which the instance before the latest one was executed
  • Attestation Requests.Previous Request Completion Time, Date and Time at which the instance before the latest one was completed
Throws:
tcAPIException, - If an error occurs while getting the attestation requests
Thor.API.Exceptions.tcAPIException
Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1991, 2006 Oracle. All rights reserved.