Thor.API.Operations
Interface AttestationDefinitionOperationsIntf

public interface AttestationDefinitionOperationsIntf

Method Summary

void	addAdministrators(long processDefKey, com.thortech.xl.vo.AdminPermissions[] admins) Add a list of groups to have administrative controls over a specified attestation process
long	createAttestationDefinition(com.thortech.xl.vo.AttestationProcessDefinition definition) Creates a new Attestation Process
void	deleteAttestationDefinition(long processDefKey) Deletes an attestation process definition
void	disableAttestationDefinition(long processDefKey) Disables an enabled attestation process definition
void	enableAttestationDefinition(long processDefKey) Enables a disabled attestation process definition
Thor.API.tcResultSet	findAttestationProcesses(java.util.Map attributes) Returns a list of attestation processes that match the provided attributes list
Thor.API.tcResultSet	getAdministrators(long processDefKey) Returns the list of administrators for a given attestation process.
com.thortech.xl.vo.AttestationProcessDefinition	getAttestationProcessDefinition(long processDefKey) Returns the attestation process definition given a process definition key
Thor.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 process
void	updateAdministrators(long processDefKey, com.thortech.xl.vo.AdminPermissions[] admins) Updates the administrative controls over a specified attestation process
void	updateAttestationDefinition(long processDefKey, com.thortech.xl.vo.AttestationProcessDefinition definition) Updates a given attestation process definition.

Method Detail

createAttestationDefinition

public long createAttestationDefinition(com.thortech.xl.vo.AttestationProcessDefinition definition)
                                 throws Thor.API.Exceptions.DuplicateAttestationProcessException,
                                        Thor.API.Exceptions.tcAPIException,
                                        tcAPIException

Creates a new Attestation Process

Returns:

Key of the created attestation process

Throws:

DuplicateAttestationProcessException, - if a process with same name or code exists

tcAPIException, - If an error occurs while querying or saving the process data

Thor.API.Exceptions.DuplicateAttestationProcessException

Thor.API.Exceptions.tcAPIException

enableAttestationDefinition

public void enableAttestationDefinition(long processDefKey)
                                 throws Thor.API.Exceptions.tcInvalidPermissionsException,
                                        Thor.API.Exceptions.tcAPIException,
                                        tcAPIException

Enables a disabled attestation process definition

Throws:

tcInvalidPermissionsException, - If any non administrator users attempts to enable the process

tcAPIException, - If process is not Disabled or next start time is in the past

Thor.API.Exceptions.tcInvalidPermissionsException

Thor.API.Exceptions.tcAPIException

disableAttestationDefinition

public void disableAttestationDefinition(long processDefKey)
                                  throws Thor.API.Exceptions.tcInvalidPermissionsException,
                                         Thor.API.Exceptions.tcAPIException,
                                         tcAPIException

Disables an enabled attestation process definition

Parameters:

processDefKey - Attestation Process that needs to be disabled

Throws:

tcInvalidPermissionsException, - If any non administrator users attempts to disable the process

tcAPIException, - If process is not in Active status

Thor.API.Exceptions.tcInvalidPermissionsException

Thor.API.Exceptions.tcAPIException

deleteAttestationDefinition

public void deleteAttestationDefinition(long processDefKey)
                                 throws Thor.API.Exceptions.tcInvalidPermissionsException,
                                        Thor.API.Exceptions.tcAPIException,
                                        tcAPIException

Deletes an attestation process definition

Parameters:

processDefKey - Attestation Process that needs to be deleted

Throws:

tcInvalidPermissionsException, - If any non administrator users attempts to delete the process

tcAPIException, - If process is already deleted

Thor.API.Exceptions.tcInvalidPermissionsException

Thor.API.Exceptions.tcAPIException

getAdministrators

public Thor.API.tcResultSet getAdministrators(long processDefKey)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.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, - If an error occurs while getting the administrators

tcAttestationProcessNotFoundException, - if the specified process key does not exist in the system

Thor.API.Exceptions.tcAPIException

Thor.API.Exceptions.AttestationProcessNotFoundException

getUnassignedAdministrators

public Thor.API.tcResultSet getUnassignedAdministrators(long processDefKey)
                                                 throws Thor.API.Exceptions.tcAPIException,
                                                        Thor.API.Exceptions.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, - If an error occurs while getting the administrators

tcAttestationProcessNotFoundException, - if the specified process key does not exist in the system

Thor.API.Exceptions.tcAPIException

Thor.API.Exceptions.AttestationProcessNotFoundException

addAdministrators

public void addAdministrators(long processDefKey,
                              com.thortech.xl.vo.AdminPermissions[] admins)
                       throws Thor.API.Exceptions.tcBulkException,
                              Thor.API.Exceptions.AttestationProcessNotFoundException,
                              Thor.API.Exceptions.tcAdminNotFoundException,
                              Thor.API.Exceptions.tcAPIException,
                              tcAPIException

Add a list of groups to have administrative controls over a specified attestation process

Throws:

tcBulkException

AttestationProcessNotFoundException, - if the specified attestation process does not exist

tcAdminNotFoundException, - if one or more administrators specified do not exist

tcAPIException, - if any errors occur while validating the process and administrators provided

Thor.API.Exceptions.AttestationProcessNotFoundException

Thor.API.Exceptions.tcAdminNotFoundException

Thor.API.Exceptions.tcAPIException

updateAdministrators

public void updateAdministrators(long processDefKey,
                                 com.thortech.xl.vo.AdminPermissions[] admins)
                          throws Thor.API.Exceptions.tcBulkException,
                                 Thor.API.Exceptions.AttestationProcessNotFoundException,
                                 Thor.API.Exceptions.tcAdminNotFoundException,
                                 Thor.API.Exceptions.tcAPIException,
                                 tcAPIException

Updates the administrative controls over a specified attestation process

Throws:

tcBulkException

AttestationProcessNotFoundException, - if the specified attestation process does not exist

tcAdminNotFoundException, - if one or more administrators specified do not exist

tcAPIException, - if any errors occur while validating the process and administrators provided

Thor.API.Exceptions.AttestationProcessNotFoundException

Thor.API.Exceptions.tcAdminNotFoundException

Thor.API.Exceptions.tcAPIException

updateAttestationDefinition

public void updateAttestationDefinition(long processDefKey,
                                        com.thortech.xl.vo.AttestationProcessDefinition definition)
                                 throws Thor.API.Exceptions.DuplicateAttestationProcessException,
                                        Thor.API.Exceptions.tcInvalidPermissionsException,
                                        Thor.API.Exceptions.tcAPIException,
                                        Thor.API.Exceptions.AttestationProcessNotFoundException,
                                        tcAPIException

Updates a given attestation process definition.

Throws:

DuplicateAttestationProcessException, - If any other attestation process has the same process name or code

tcInvalidPermissionsException, - If user calling the API does not belong to the administrative group of the process

tcAPIException, - If an error occurs while querying or saving the process data or attepmting to change start time after process is instantiated

AttestationProcessNotFoundException, - if the provided process definition key does not exists

Thor.API.Exceptions.DuplicateAttestationProcessException

Thor.API.Exceptions.tcInvalidPermissionsException

Thor.API.Exceptions.tcAPIException

Thor.API.Exceptions.AttestationProcessNotFoundException

removeAdministrators

public void removeAdministrators(long processDefKey,
                                 long[] adminGroupKeys)
                          throws Thor.API.Exceptions.tcAdminNotFoundException,
                                 Thor.API.Exceptions.AttestationProcessNotFoundException,
                                 Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

Removes a list of groups from having administrative control over a specified attestation process

Parameters:

processDefKey - - The key of the Attestation process

adminGroupKeys - - The keys of the admin groups

Throws:

tcAdminNotFoundException - thrown if one or many adminGroupKeys do not exist

AttestationProcessNotFoundException - thrown if processDefKey does not exist

tcAPIException - thrown if data set errors occur OR while deleting OR Group key doesn't correspond to Administrator Group keys

tcBulkException - DOCUMENT ME!

findAttestationProcesses

public Thor.API.tcResultSet findAttestationProcesses(java.util.Map attributes)
                                              throws Thor.API.Exceptions.tcAPIException,
                                                     tcAPIException

Returns a list of attestation processes that match the provided attributes list

Parameters:

attributes - A Map of attribute-value pairs with each entry containing criteria to find attestation processes. The Map key should contain a String representation of the metadata codes. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map 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

When one of the above attributes is specified in the hash map, API also expects the Attestation Definition.Scope Type attribute in the hash map. If not, tcAPIException will be thrown. If the Attestation Definition.Scope Type value is specified, it has to be the following. For

• 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

Throws:

tcAPIException, - If an error occurs while querying the process data

Thor.API.Exceptions.tcAPIException

getAttestationProcessDefinition

public com.thortech.xl.vo.AttestationProcessDefinition getAttestationProcessDefinition(long processDefKey)
                                                                                throws Thor.API.Exceptions.tcAPIException,
                                                                                       Thor.API.Exceptions.AttestationProcessNotFoundException,
                                                                                       tcAPIException

Returns the attestation process definition given a process definition key

Returns:

a value object containing the attestation process definition

Throws:

tcAPIException, - If an error occurs while retrieving the data

AttestationProcessNotFoundException, - if the specified process definition key does not exists

Thor.API.Exceptions.tcAPIException

Thor.API.Exceptions.AttestationProcessNotFoundException