|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttestationDefinitionOperationsIntf
Method Summary | |
---|---|
void |
addAdministrators(long processDefKey, AdminPermissions[] admins) Add a list of groups to have administrative controls over a specified attestation process |
long |
createAttestationDefinition(AttestationProcessDefinitionVO 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. |
AttestationProcessDefinitionVO |
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, AdminPermissions[] admins) Updates the administrative controls over a specified attestation process |
void |
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 Detail |
---|
long createAttestationDefinition(AttestationProcessDefinitionVO definition) throws DuplicateAttestationProcessException, tcAPIException, tcAPIException
definition,
- Value object containing the attestation process definition data that to be createdDuplicateAttestationProcessException,
- if a process with same name or code existstcAPIException,
- If an error occurs while querying or saving the process dataDuplicateAttestationProcessException
tcAPIException
void enableAttestationDefinition(long processDefKey) throws tcInvalidPermissionsException, tcAPIException, tcAPIException
processDefKey,
- Attestation Process that needs to be enabledtcInvalidPermissionsException,
- If any non administrator users attempts to enable the processtcAPIException,
- If process is not Disabled or next start time is in the pasttcInvalidPermissionsException
tcAPIException
void disableAttestationDefinition(long processDefKey) throws tcInvalidPermissionsException, tcAPIException, tcAPIException
processDefKey
- Attestation Process that needs to be disabledtcInvalidPermissionsException,
- If any non administrator users attempts to disable the processtcAPIException,
- If process is not in Active statustcInvalidPermissionsException
tcAPIException
void deleteAttestationDefinition(long processDefKey) throws tcInvalidPermissionsException, tcAPIException, tcAPIException
processDefKey
- Attestation Process that needs to be deletedtcInvalidPermissionsException,
- If any non administrator users attempts to delete the processtcAPIException,
- If process is already deletedtcInvalidPermissionsException
tcAPIException
Thor.API.tcResultSet getAdministrators(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException
processDefKey
- Attestation process definition keytcResultSet
that contains the following information:
tcAPIException,
- If an error occurs while getting the administratorstcAttestationProcessNotFoundException,
- if the specified process key does not exist in the systemtcAPIException
AttestationProcessNotFoundException
Thor.API.tcResultSet getUnassignedAdministrators(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException
processDefKey
- Attestation process definition keytcResultSet
that contains the following information:
tcAPIException,
- If an error occurs while getting the administratorstcAttestationProcessNotFoundException,
- if the specified process key does not exist in the systemtcAPIException
AttestationProcessNotFoundException
void addAdministrators(long processDefKey, AdminPermissions[] admins) throws tcBulkException, AttestationProcessNotFoundException, tcAdminNotFoundException, tcAPIException, tcAPIException
processDefKey,
- Attestation Process Definition Keyadmins,
- An array of value objects containing the admin groups and permissionstcBulkException
AttestationProcessNotFoundException,
- if the specified attestation process does not existtcAdminNotFoundException,
- if one or more administrators specified do not existtcAPIException,
- if any errors occur while validating the process and administrators providedAttestationProcessNotFoundException
tcAdminNotFoundException
tcAPIException
void updateAdministrators(long processDefKey, AdminPermissions[] admins) throws tcBulkException, AttestationProcessNotFoundException, tcAdminNotFoundException, tcAPIException, tcAPIException
processDefKey,
- Attestation Process Definition Keyadmins,
- An array of value objects containing the admin groups and permissionstcBulkException
AttestationProcessNotFoundException,
- if the specified attestation process does not existtcAdminNotFoundException,
- if one or more administrators specified do not existtcAPIException,
- if any errors occur while validating the process and administrators providedAttestationProcessNotFoundException
tcAdminNotFoundException
tcAPIException
void updateAttestationDefinition(long processDefKey, AttestationProcessDefinitionVO definition) throws DuplicateAttestationProcessException, tcInvalidPermissionsException, tcAPIException, AttestationProcessNotFoundException, tcAPIException
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.DuplicateAttestationProcessException,
- If any other attestation process has the same process name or codetcInvalidPermissionsException,
- If user calling the API does not belong to the administrative group of the processtcAPIException,
- If an error occurs while querying or saving the process data or attepmting to change start time after process is instantiatedAttestationProcessNotFoundException,
- if the provided process definition key does not existsDuplicateAttestationProcessException
tcInvalidPermissionsException
tcAPIException
AttestationProcessNotFoundException
void removeAdministrators(long processDefKey, long[] adminGroupKeys) throws tcAdminNotFoundException, AttestationProcessNotFoundException, tcAPIException, tcBulkException, tcAPIException
processDefKey
- - The key of the Attestation processadminGroupKeys
- - The keys of the admin groupstcAdminNotFoundException
- 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!Thor.API.tcResultSet findAttestationProcesses(java.util.Map attributes) throws tcAPIException, tcAPIException
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(*).tcResultSet
that contains the following information:
tcAPIException,
- If an error occurs while querying the process datatcAPIException
AttestationProcessDefinitionVO getAttestationProcessDefinition(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException, tcAPIException
processDefKey,
- Attestation process definition keytcAPIException,
- If an error occurs while retrieving the dataAttestationProcessNotFoundException,
- if the specified process definition key does not existstcAPIException
AttestationProcessNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |