Package Thor.API.Operations
Interface AttestationDefinitionOperationsIntf
- All Superinterfaces:
tcUtilityOperationsIntf
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAdministrators
(long processDefKey, AdminPermissions[] admins) Add a list of groups to have administrative controls over a specified attestation processlong
Creates a new Attestation Processvoid
deleteAttestationDefinition
(long processDefKey) Deletes an attestation process definitionvoid
disableAttestationDefinition
(long processDefKey) Disables an enabled attestation process definitionvoid
enableAttestationDefinition
(long processDefKey) Enables a disabled attestation process definitionThor.API.tcResultSet
findAttestationProcesses
(Map attributes) Returns a list of attestation processes that match the provided attributes listThor.API.tcResultSet
getAdministrators
(long processDefKey) Returns the list of administrators for a given attestation process.getAttestationProcessDefinition
(long processDefKey) Returns the attestation process definition given a process definition keyThor.API.tcResultSet
getUnassignedAdministrators
(long processDefKey) Returns the list of unassigned administrative groups for a given attestation process.void
removeAdministrators
(long processDefKey, long[] adminGroupKeys) Removes a list of groups from having administrative control over a specified attestation processvoid
updateAdministrators
(long processDefKey, AdminPermissions[] admins) Updates the administrative controls over a specified attestation processvoid
updateAttestationDefinition
(long processDefKey, AttestationProcessDefinitionVO definition) Updates a given attestation process definition.Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf
close, getName, setCountry, setLanguage, setVariant
-
Method Details
-
createAttestationDefinition
long createAttestationDefinition(AttestationProcessDefinitionVO definition) throws DuplicateAttestationProcessException, tcAPIException, tcAPIException Creates a new Attestation Process- Parameters:
definition
- , Value object containing the attestation process definition data that to be created- Returns:
- Key of the created attestation process
- Throws:
DuplicateAttestationProcessException
tcAPIException
tcAPIException
-
enableAttestationDefinition
void enableAttestationDefinition(long processDefKey) throws tcInvalidPermissionsException, tcAPIException, tcAPIException Enables a disabled attestation process definition- Parameters:
processDefKey
- , Attestation Process that needs to be enabled- Throws:
tcInvalidPermissionsException
tcAPIException
tcAPIException
-
disableAttestationDefinition
void disableAttestationDefinition(long processDefKey) throws tcInvalidPermissionsException, tcAPIException, tcAPIException Disables an enabled attestation process definition- Parameters:
processDefKey
- Attestation Process that needs to be disabled- Throws:
tcInvalidPermissionsException
tcAPIException
tcAPIException
-
deleteAttestationDefinition
void deleteAttestationDefinition(long processDefKey) throws tcInvalidPermissionsException, tcAPIException, tcAPIException Deletes an attestation process definition- Parameters:
processDefKey
- Attestation Process that needs to be deleted- Throws:
tcInvalidPermissionsException
tcAPIException
tcAPIException
-
getAdministrators
Thor.API.tcResultSet getAdministrators(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException Returns the list of administrators for a given attestation process.- Parameters:
processDefKey
- Attestation process definition key- Returns:
- A
tcResultSet
that contains the following information:- Groups.Group Name, Attestation admin group name
- Groups.Key, Attestation admin group key
- Attestation Definition-Groups.Write Permission, indicates whether admin has write permissions over the process or not
- Attestation Definition-Groups.Delete Permission, indicates whether admin has delete permissions over the process or not
- Throws:
tcAPIException
AttestationProcessNotFoundException
tcAPIException
-
getUnassignedAdministrators
Thor.API.tcResultSet getUnassignedAdministrators(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException Returns the list of unassigned administrative groups for a given attestation process. Returns only the groups the logged in user have at least read permissions over- Parameters:
processDefKey
- Attestation process definition key- Returns:
- A
tcResultSet
that contains the following information:- Groups.Group Name
- Groups.Key
- Throws:
tcAPIException
AttestationProcessNotFoundException
tcAPIException
-
addAdministrators
void addAdministrators(long processDefKey, AdminPermissions[] admins) throws tcBulkException, AttestationProcessNotFoundException, tcAdminNotFoundException, tcAPIException, tcAPIException Add a list of groups to have administrative controls over a specified attestation process- Parameters:
processDefKey
- , Attestation Process Definition Keyadmins
- , An array of value objects containing the admin groups and permissions- Throws:
tcBulkException
AttestationProcessNotFoundException
tcAdminNotFoundException
tcAPIException
tcAPIException
-
updateAdministrators
void updateAdministrators(long processDefKey, AdminPermissions[] admins) throws tcBulkException, AttestationProcessNotFoundException, tcAdminNotFoundException, tcAPIException, tcAPIException Updates the administrative controls over a specified attestation process- Parameters:
processDefKey
- , Attestation Process Definition Keyadmins
- , An array of value objects containing the admin groups and permissions- Throws:
tcBulkException
AttestationProcessNotFoundException
tcAdminNotFoundException
tcAPIException
tcAPIException
-
updateAttestationDefinition
void updateAttestationDefinition(long processDefKey, AttestationProcessDefinitionVO definition) throws DuplicateAttestationProcessException, tcInvalidPermissionsException, tcAPIException, AttestationProcessNotFoundException, tcAPIException Updates a given attestation process definition.- Parameters:
processDefKey
- , Attestation Process Key that needs to be updateddefinition
- , value object containing the new process definition values. This value object should contain values for all the fields that new attestation process should have and not just the changes.- Throws:
DuplicateAttestationProcessException
tcInvalidPermissionsException
tcAPIException
AttestationProcessNotFoundException
tcAPIException
-
removeAdministrators
void removeAdministrators(long processDefKey, long[] adminGroupKeys) throws tcAdminNotFoundException, AttestationProcessNotFoundException, tcAPIException, tcBulkException, tcAPIException Removes a list of groups from having administrative control over a specified attestation process- Parameters:
processDefKey
- - The key of the Attestation processadminGroupKeys
- - The keys of the admin groups- Throws:
tcAdminNotFoundException
- thrown if one or many adminGroupKeys do not existAttestationProcessNotFoundException
- thrown if processDefKey does not existtcAPIException
- thrown if data set errors occur OR while deleting OR Group key doesn't correspond to Administrator Group keystcBulkException
- DOCUMENT ME!
-
findAttestationProcesses
Returns a list of attestation processes that match the provided attributes list- Parameters:
attributes
- AMap
of attribute-value pairs with each entry containing criteria to find attestation processes. TheMap
key should contain aString
representation of the metadata codes. TheMap
value can contain aString
representation of the criteria to find the desired requests. Note that theMap
values can include wild cards(*).
Attestation Processes can also be searched the following- Scope Parameter.Group Name, Group Name of the attestation scope parameter
- Scope Parameter.Organization Name, Organization Name of the attestation scope parameter
- Scope Parameter.Manager User Id, Manager User Login of the attestation scope parameter
- Scope Parameter.Resource Name, Resource Name of the attestation scope parameter
- Scope Parameter.Group Name, scope type value has to be 'By Group'
- Scope Parameter.Organization Name, scope type value has to be 'By Organization'
- Scope Parameter.Manager User Id, scope type value has to be 'By Manager'
- Scope Parameter.Resource Name, scope type value has to be 'By Resource'
To search processes on reviewer type, attribute key needs to be Attestation Definition.Reviewer Type and value has to either Single User or User Manager. Processes can also be searched on reviewer user id. To search on reviewer user id, key in the hash map needs to be REVIEWERUSERID- Returns:
- A
tcResultSet
that contains the following information:- Attestation Definition.Key, Attestation process key
- Attestation Definition.Process Name, Attestation Process Name
- Attestation Definition.Process Code, Attestation Process Code
- Attestation Definition.Process Description, Attestation Process Description
- Attestation Definition.Process Status, Status of the attestation process
- Attestation Definition.Send Email To Owner, Indicates whether emails should be sent to process owners about declined attestation records or not
- Attestation Definition.Schedule Type, Process Schedule Type
- Attestation Definition.Schedule Frequency, Process schedule frequency
- Attestation Definition.Start Time, Time at which process kicked in for the first time
- Attestation Definition.Next Start Time, Process next start time
- Attestation Definition.Last Start Time, Time at which the last instance of the process was kicked in
- Attestation Definition.Last Completion Time, Time at which the last instance of the process was completed
- Attestation Definition.Scope Type, Process scope type
- Attestation Definition.Scope Parameter, Process scope parameter key
- Attestation Definition.Reviewer Type, Process reviewer type
- Attestation Definition.Reviewer, Process reviewer key
- Attestation Definition.Process Owner, Group key of the process owner
- Attestation Definition.Key, Attestation process key
- Throws:
tcAPIException
tcAPIException
-
getAttestationProcessDefinition
AttestationProcessDefinitionVO getAttestationProcessDefinition(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException Returns the attestation process definition given a process definition key- Parameters:
processDefKey
- , Attestation process definition key- Returns:
- a value object containing the attestation process definition
- Throws:
tcAPIException
AttestationProcessNotFoundException
tcAPIException
-