public interface AttestationOperationsIntf extends tcUtilityOperationsIntf
Modifier and Type | Method and Description |
---|---|
void |
attestSpecificTask(java.lang.String[] attestationTaskKeys,
long attestationTaskKey)
This API attests the specific tasks and initiates any work flow setup.
|
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.
|
Thor.API.tcResultSet |
getAttestationRequestDetails(long attestationRequestKey,
java.util.Map attributes,
int startRow,
int pageSize,
java.lang.String[] order,
boolean ascendingOrder)
Returns the attestation records associated with an attestation request.
|
int |
getAttestationRequestTasksCount(long attestationRequestKey)
Returns the attestation records associated with an attestation request.
|
com.thortech.xl.dataobj.tcDataSet |
getAttestationTaskDetailKeys(long attestationRequestKey)
Returns the attestation records associated with an attestation request.
|
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 |
getPendingAttestationTasks(long userKey,
java.util.Map searchCriterion)
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 |
sendWarningEmails(java.util.List lstKeys)
Sends the warning emails
|
void |
submitReponses(long attestationTaskKey,
AttestationItemResponse[] responses,
java.lang.String defaultDelegate,
java.lang.String defalutComment)
Submits the specified responses on the records of a attestation task
|
void |
updateResponses(java.lang.String[] atd_keys,
java.lang.String apd_key,
java.lang.String apt_key)
Submits the attestation task when the grace period expires and response for each task is to be set to delegated and the process is thus to be delegated to some other user
|
close, getName, setCountry, setLanguage, setVariant
void initiateAttestationProcess(java.lang.String processName) throws tcAPIException, tcInvalidPermissionsException, AttestationProcessNotFoundException, tcAPIException
processName,
- Name of the Attestation Process to be instantiatedAttestationProcessNotFoundException,
- If the specified attestation process name does not existtcAPIException,
- If an error occurs while querying or creating attestation requeststcInvalidPermissionsException,
- If the process is not instantiated by scheduler or process ownertcAPIException
tcInvalidPermissionsException
AttestationProcessNotFoundException
void submitReponses(long attestationTaskKey, AttestationItemResponse[] responses, java.lang.String defaultDelegate, java.lang.String defalutComment) throws TaskAlreadyAttestedException, tcAPIException, tcInvalidPermissionsException, UnknownAttestationRecordResponse, tcAPIException
attestationTaskKey,
- Attestation task key on which responses to be submittedresponses,
- Value object containing the record keys and responses to be submitted for each of the recordsdefaultDelegate,
- If the response for a record is 'Delegate' and corresponding delegate value is not provided, this value will be used. Value should be a user logindefalutComment,
- Uses this value for all the records where comment is not providedTaskAlreadyAttestedException,
- If responses for all the records are already provided and task is already sumbmitted for attestationtcAPIException,
- If any of the records do not belong to the specified attestation task or user to delegate is not specified for one or more attestation records where the response specified is delegatetcInvalidPermissionsException,
- if the logged in user is not same as the attestation task reviewerUnknownAttestationRecordResponse,
- If responses provided for one or more records is not Certify/Reject/Decline/DelegateTaskAlreadyAttestedException
tcAPIException
tcInvalidPermissionsException
UnknownAttestationRecordResponse
void attestTask(long attestationTaskKey) throws MissingResponsesException, tcAPIException, tcInvalidPermissionsException, tcAPIException
attestationTaskKey,
- Task to be attestedMissingResponsesException,
- If response is not provided to one or more records in the tasktcAPIException,
- If an error occurs while querying for the datatcInvalidPermissionsException,
- if the logged in user is not same as the attestation task reviewerMissingResponsesException
tcAPIException
tcInvalidPermissionsException
void attestSpecificTask(java.lang.String[] attestationTaskKeys, long attestationTaskKey) throws MissingResponsesException, tcAPIException, tcInvalidPermissionsException, tcAPIException
attestationTaskKeys
- tasks to be attestedMissingResponsesException,
- If response is not provided to one or more records in the tasktcAPIException,
- If an error occurs while querying for the datatcInvalidPermissionsException,
- if the logged in user is not same as the attestation task reviewerMissingResponsesException
tcAPIException
tcInvalidPermissionsException
Thor.API.tcResultSet getPendingAttestationTasks(long userKey, java.util.Map searchCriterion) throws tcAPIException, tcAPIException
userKey,
- User for whom the tasks are assignedtcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the task datatcAPIException
Thor.API.tcResultSet getPendingAttestationTasks(long userKey) throws tcAPIException, tcAPIException
userKey,
- User for whom the tasks are assignedtcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the task datatcAPIException
UDFormData getEntitlementRecordDetails(long recordKey) throws tcAPIException, tcAPIException
recordKey,
- Attestation Record KeytcAPIException,
- If an error occurs while retrieving the datatcAPIException
int getAttestationRequestTasksCount(long attestationRequestKey) throws tcAPIException, tcAPIException
attestationRequestKey,
- Attestation Request keyattributes,
- Values to filter the results on. Only supported filter column are 'Attestation Tasks.Key' and 'Attestation Data.Record Status'startRow,
- the start row to retrieve the datapageSize,
- Number of rows to retrievetcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the datatcAPIException
Thor.API.tcResultSet getAttestationRequestDetails(long attestationRequestKey, java.util.Map attributes, int startRow, int pageSize) throws tcAPIException, tcAPIException
attestationRequestKey,
- Attestation Request keyattributes,
- Values to filter the results on. Only supported filter column are 'Attestation Tasks.Key' and 'Attestation Data.Record Status'startRow,
- the start row to retrieve the datapageSize,
- Number of rows to retrievetcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the datatcAPIException
Thor.API.tcResultSet getAttestationRequestDetails(long attestationRequestKey, java.util.Map attributes, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) throws tcAPIException, tcAPIException
attestationRequestKey,
- Attestation Request keyattributes,
- Values to filter the results on. Only supported filter column are 'Attestation Tasks.Key' and 'Attestation Data.Record Status'startRow,
- the start row to retrieve the datapageSize,
- Number of rows to retrieveorder,
- The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.ascendingOrder,A
- boolean value if the sorting is to be ascending or descendingtcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the datatcAPIException
Thor.API.tcResultSet getRequestDetailsForDashBoard(long attestationRequestKey, java.util.Map attributes, int startRow, int pageSize) throws tcAPIException, tcAPIException
attestationRequestKey,
- Attestation Request keyattributes,
- Values to filter the results on. Only supported filter column are 'Attestation Tasks.Key' and 'Attestation Data.Record Status'startRow,
- the start row to retrieve the datapageSize,
- Number of rows to retrievetcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the datatcAPIException
Thor.API.tcResultSet getAttestationProcessExecutionHistory(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException
processDefKey,
- Attestation process definition keytcResultSet
and returned columns vary based on the attestation scope type. tcAPIException
- if an error occurs while retrieving the attestation request dataAttestationProcessNotFoundException,
- If the specified attestation process key does not existAttestationProcessNotFoundException
Thor.API.tcResultSet getAttestationRecordDelegatedPath(long recordKey) throws tcAPIException, AttestationRecordNotDelegatedException, tcAPIException
recordKey,
- Record for which to retrieve the delegation pathtcResultSet
that contains the following information: tcAPIException,
- If an error occurs while getting the delegation pathAttestationRecordNotDelegatedException,
- If the specified record is not delegatedtcAPIException
AttestationRecordNotDelegatedException
Thor.API.tcResultSet getOwnerAttestationProcesses() throws tcAPIException, tcAPIException
tcResultSet
that contains the following information: tcAPIException,
- If an error occurs while getting the attestation requeststcAPIException
com.thortech.xl.dataobj.tcDataSet getAttestationTaskDetailKeys(long attestationRequestKey) throws tcAPIException, tcAPIException
attestationRequestKey,
- Attestation Request keyattributes,
- Values to filter the results on. Only supported filter column are 'Attestation Tasks.Key' and 'Attestation Data.Record Status'startRow,
- the start row to retrieve the datapageSize,
- Number of rows to retrievetcResultSet
that contains the following information: tcAPIException,
- If an error occurs while retrieving the datatcAPIException
void updateResponses(java.lang.String[] atd_keys, java.lang.String apd_key, java.lang.String apt_key) throws com.thortech.xl.orb.dataaccess.tcDataAccessException, tcAPIException, com.thortech.xl.dataaccess.tcDataSetException, tcAPIException
atd_keys
- apd_key
- apt_key
- com.thortech.xl.orb.dataaccess.tcDataAccessException
tcAPIException
com.thortech.xl.dataaccess.tcDataSetException
void sendWarningEmails(java.util.List lstKeys) throws tcAPIException, tcAPIException
lstKeys
- List of APT Keys for which mail is to be senttcAPIException