Thor.API.Operations

Interface tcFormInstanceOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcFormInstanceOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method and Description
long	addProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey, java.util.Map phAttributeList) Adds process data to the child form that is associated with an instance of a process in the system.
long	addProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey, java.util.Map phAttributeList, boolean createHolder, boolean createSODChecker) Adds process data to the child form that is associated with an instance of a process in the system.
void	executeSODCheck(long plProcessInstanceKey) Initiates SOD Check by creating SODChecker Instance
int	getActiveVersion(long plFormDefinitionKey) Returns the active version of the form specified.
Thor.API.tcResultSet	getChildFormDefinition(long plParentFormDefinitionKey, int pnParentFormVersion) Deprecated. The version with which the process instance was saved is no longer tracked. All the process instances are assumed to be associated with the active version of the form. This API will ignore the parentFormVersion parameter and return the child form definition associated with the active parent form version.
Thor.API.tcResultSet	getProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey) Returns the process data that is saved in a child form and associated with an instance of a process in the system.
Thor.API.tcResultSet	getProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey, long childPrimaryKey) Returns the single row of child form process data that is associated with a specific child primary key and an instance of a process in the system.
Thor.API.tcResultSet	getProcessFormData(long plProcessInstanceKey) Returns the process data associated with an instance of a process in the system.
Thor.API.tcResultSet	getProcessFormDataInViewMode(long plProcessInstanceKey) Returns the process data associated with an instance of a process in the system.
long	getProcessFormDefinitionKey(long plProcessInstanceKey) Returns the form definition key associated with an instance of a process in the system.
int	getProcessFormVersion(long plProcessInstanceKey) Deprecated. The version with which the process instance was saved is no longer tracked. All the process instances are assumed to be associated with the active version of the form. Use getActiveVersion( long plFormDefinitionKey ) instead.
Thor.API.tcResultSet	prepopulateObjectForm(long plUserKey, long plFormDefinitionKey, java.util.Map phFormValues) Deprecated.
Thor.API.tcResultSet	prepopulateProcessForm(long plProcessInstanceKey, long plFormDefinitionKey, java.util.Map phFormValues) Pre-populates the process form's data based on pre-population rules and adapters.
void	removeProcessFormChildData(long plChildFormDefinitionKey, long plChildFormPrimaryKey) Removes process data from the child form that is associated with an instance of a process in the system.
void	setProcessFormData(long plProcessInstanceKey, java.util.Map phAttributeList) Sets the process data associated with an instance of a process in the system.
void	updateProcessFormChildData(long plChildFormDefinitionKey, long plChildFormPrimaryKey, java.util.Map phAttributeList) Updates process data on the child form that is associated with an instance of a process in the system.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

getProcessFormDataInViewMode

Thor.API.tcResultSet getProcessFormDataInViewMode(long plProcessInstanceKey)
                                           throws tcNotAtomicProcessException,
                                                  tcFormNotFoundException,
                                                  tcAPIException,
                                                  tcProcessNotFoundException,
                                                  tcAPIException

Returns the process data associated with an instance of a process in the system. If the process data has not been saved yet, then it returns any values that need to be pre-filled into the form, according to rules or data flows.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

Returns:

A tcResultSet containing one row, holding data used by the provisioning process. The resultset contains, in addition to the process form fields, the following columns:

• UD_FORMNAME_CREATE
• UD_FORMNAME_CREATEBY
• UD_FORMNAME_DATA_LEVEL
• UD_FORMNAME_KEY
• UD_FORMNAME_NOTE
• UD_FORMNAME_ROWVER
• UD_FORMNAME_UPDATE
• UD_FORMNAME_UPDATEBY
• UD_FORMNAME_VERSION
• Process Instance.Key
• Access Policies.Key

Throws:

tcNotAtomicProcessException

tcFormNotFoundException

tcAPIException

tcProcessNotFoundException

getProcessFormData

Thor.API.tcResultSet getProcessFormData(long plProcessInstanceKey)
                                 throws tcNotAtomicProcessException,
                                        tcFormNotFoundException,
                                        tcAPIException,
                                        tcProcessNotFoundException,
                                        tcAPIException

Returns the process data associated with an instance of a process in the system. If the process data has not been saved yet, then it returns any values that need to be pre-filled into the form, according to rules or data flows.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

Returns:

A tcResultSet containing one row, holding data used by the provisioning process. The resultset contains, in addition to the process form fields, the following columns:

• UD_FORMNAME_CREATE
• UD_FORMNAME_CREATEBY
• UD_FORMNAME_DATA_LEVEL
• UD_FORMNAME_KEY
• UD_FORMNAME_NOTE
• UD_FORMNAME_ROWVER
• UD_FORMNAME_UPDATE
• UD_FORMNAME_UPDATEBY
• UD_FORMNAME_VERSION
• Process Instance.Key
• Access Policies.Key

Throws:

tcNotAtomicProcessException

tcFormNotFoundException

tcAPIException

tcProcessNotFoundException

setProcessFormData

void setProcessFormData(long plProcessInstanceKey,
                        java.util.Map phAttributeList)
                 throws tcAPIException,
                        tcInvalidValueException,
                        tcNotAtomicProcessException,
                        tcFormNotFoundException,
                        tcRequiredDataMissingException,
                        tcProcessNotFoundException,
                        tcAPIException

Sets the process data associated with an instance of a process in the system. If the process data already exists, then it updates the data with the specified values. In the case of a first-time save, all the required data must be provided. In the case of subsequent saves, only data being updated need be provided.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

phAttributeList - An array of tcMapping objects, each used to specify the attribute name-value pairs to be used to save data to the form

Throws:

tcAPIException - an error code of DOBJ.USR_PASSWORD_DOES_NOT_MATCH_POLICY might be set within this exception. If that's the case, one or many password policy rules were not met for password field in the form.

tcInvalidValueException

tcNotAtomicProcessException

tcFormNotFoundException

tcRequiredDataMissingException

tcProcessNotFoundException

getProcessFormDefinitionKey

long getProcessFormDefinitionKey(long plProcessInstanceKey)
                          throws tcProcessNotFoundException,
                                 tcFormNotFoundException,
                                 tcAPIException,
                                 tcAPIException

Returns the form definition key associated with an instance of a process in the system.

Parameters:

plProcessInstanceKey - The key of the object instance in the system.

Returns:

The form defintion key for the process form associated with the specified process instance.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException

getActiveVersion

int getActiveVersion(long plFormDefinitionKey)
              throws tcVersionNotDefinedException,
                     tcFormNotFoundException,
                     tcAPIException,
                     tcAPIException

Returns the active version of the form specified.

Parameters:

plFormDefinitionKey - The form definition key.

Returns:

The active version of the form specified.

Throws:

tcVersionNotDefinedException

tcFormNotFoundException

tcAPIException

getProcessFormVersion

@Deprecated
int getProcessFormVersion(long plProcessInstanceKey)
                               throws tcNotAtomicProcessException,
                                      tcFormNotFoundException,
                                      tcVersionNotFoundException,
                                      tcAPIException,
                                      tcAPIException

Deprecated. The version with which the process instance was saved is no longer tracked. All the process instances are assumed to be associated with the active version of the form. Use getActiveVersion( long plFormDefinitionKey ) instead.

Returns the form version with which the process instance was saved.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

Returns:

The version of the form with which the process instance was saved.

Throws:

tcNotAtomicProcessException

tcFormNotFoundException

tcVersionNotFoundException

tcAPIException

getChildFormDefinition

@Deprecated
Thor.API.tcResultSet getChildFormDefinition(long plParentFormDefinitionKey,
                                                        int pnParentFormVersion)
                                                 throws tcFormNotFoundException,
                                                        tcVersionNotDefinedException,
                                                        tcAPIException,
                                                        tcAPIException

Deprecated. The version with which the process instance was saved is no longer tracked. All the process instances are assumed to be associated with the active version of the form. This API will ignore the parentFormVersion parameter and return the child form definition associated with the active parent form version.

Returns information about the child form(s) of the specified parent form. This method can be used for both process and object forms.

Parameters:

plParentFormDefinitionKey - The key for the parent form definition.

pnParentFormVersion - The version of the parent form to get children for.

Returns:

A tcResultSet with each row containing information about a child of the parent form. Information returned includes the child form definition key, child form version, child table name, and child form description. The returned resultset contains the following columns:

• Structure Utility.Child Tables.Child Key
• Structure Utility.Child Tables.Child Version
• Structure Utility.Table Name
• Structure Utility.Description

Throws:

tcFormNotFoundException

tcVersionNotDefinedException

tcAPIException

getProcessFormChildData

Thor.API.tcResultSet getProcessFormChildData(long plChildFormDefinitionKey,
                                             long plProcessInstanceKey)
                                      throws tcProcessNotFoundException,
                                             tcFormNotFoundException,
                                             tcAPIException,
                                             tcAPIException

Returns the process data that is saved in a child form and associated with an instance of a process in the system.

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plProcessInstanceKey - The key of the process instance in the system.

Returns:

A tcResultSet with each row containing process data from the child form for the specified process instance. In addition to the actual child form data, the following columns are included in the resultset returned by this API:

• UD_FORMNAME_CREATE
• UD_FORMNAME_CREATEBY
• UD_FORMNAME_DATA_LEVEL
• UD_FORMNAME_KEY
• UD_FORMNAME_NOTE
• UD_FORMNAME_ROWVER
• UD_FORMNAME_UPDATE
• UD_FORMNAME_UPDATEBY
• UD_FORMNAME_VERSION
• Process Instance.Key
• Access Policies.Key

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException

getProcessFormChildData

Thor.API.tcResultSet getProcessFormChildData(long plChildFormDefinitionKey,
                                             long plProcessInstanceKey,
                                             long childPrimaryKey)
                                      throws tcProcessNotFoundException,
                                             tcFormNotFoundException,
                                             tcAPIException

Returns the single row of child form process data that is associated with a specific child primary key and an instance of a process in the system.

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plProcessInstanceKey - The key of the process instance in the system.

childPrimaryKey - The key for the specific entry in the child form.

Returns:

A tcResultSet with each row containing process data from the child form for the specified process instance. In addition to the actual child form data, the following columns are included in the resultset returned by this API:

• UD_FORMNAME_CREATE
• UD_FORMNAME_CREATEBY
• UD_FORMNAME_DATA_LEVEL
• UD_FORMNAME_KEY
• UD_FORMNAME_NOTE
• UD_FORMNAME_ROWVER
• UD_FORMNAME_UPDATE
• UD_FORMNAME_UPDATEBY
• UD_FORMNAME_VERSION
• Process Instance.Key
• Access Policies.Key

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException

executeSODCheck

void executeSODCheck(long plProcessInstanceKey)
              throws tcProcessNotFoundException,
                     tcFormNotFoundException,
                     tcRequiredDataMissingException,
                     tcInvalidValueException,
                     tcNotAtomicProcessException,
                     tcAPIException,
                     tcAPIException

Initiates SOD Check by creating SODChecker Instance

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcRequiredDataMissingException

tcInvalidValueException

tcNotAtomicProcessException

tcAPIException

Since:

9.1.0.2

addProcessFormChildData

long addProcessFormChildData(long plChildFormDefinitionKey,
                             long plProcessInstanceKey,
                             java.util.Map phAttributeList,
                             boolean createHolder,
                             boolean createSODChecker)
                      throws tcProcessNotFoundException,
                             tcFormNotFoundException,
                             tcRequiredDataMissingException,
                             tcInvalidValueException,
                             tcNotAtomicProcessException,
                             tcAPIException,
                             tcAPIException

Adds process data to the child form that is associated with an instance of a process in the system.

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plProcessInstanceKey - The key of the process instance in the system.

phAttributeList - A map of name-value pairs, each entry representing an attribute to be set in the child form. Note that the attributes must correspond with the version of the child form associated with the process instance.

createHolder - flag to create Holder Task Instance or not (to hold the data)

createSODChecker - flag to perform SOD Check or not

Returns:

The primary key of the newly created entry in the child table.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcRequiredDataMissingException

tcInvalidValueException

tcNotAtomicProcessException

tcAPIException - an error code of DOBJ.USR_PASSWORD_DOES_NOT_MATCH_POLICY might be set within this exception. If that's the case, one or many password policy rules were not met for password field in the form.

Since:

9.1.0.2

addProcessFormChildData

long addProcessFormChildData(long plChildFormDefinitionKey,
                             long plProcessInstanceKey,
                             java.util.Map phAttributeList)
                      throws tcProcessNotFoundException,
                             tcFormNotFoundException,
                             tcRequiredDataMissingException,
                             tcInvalidValueException,
                             tcNotAtomicProcessException,
                             tcAPIException,
                             tcAPIException

Adds process data to the child form that is associated with an instance of a process in the system.

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plProcessInstanceKey - The key of the process instance in the system.

phAttributeList - A map of name-value pairs, each entry representing an attribute to be set in the child form. Note that the attributes must correspond with the version of the child form associated with the process instance.

Returns:

The primary key of the newly created entry in the child table.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcRequiredDataMissingException

tcInvalidValueException

tcNotAtomicProcessException

tcAPIException - an error code of DOBJ.USR_PASSWORD_DOES_NOT_MATCH_POLICY might be set within this exception. If that's the case, one or many password policy rules were not met for password field in the form.

removeProcessFormChildData

void removeProcessFormChildData(long plChildFormDefinitionKey,
                                long plChildFormPrimaryKey)
                         throws tcFormNotFoundException,
                                tcFormEntryNotFoundException,
                                tcAPIException,
                                tcAPIException

Removes process data from the child form that is associated with an instance of a process in the system.

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plChildFormPrimaryKey - The primary key of the child table entry to be removed.

Throws:

tcFormNotFoundException

tcFormEntryNotFoundException

tcAPIException

updateProcessFormChildData

void updateProcessFormChildData(long plChildFormDefinitionKey,
                                long plChildFormPrimaryKey,
                                java.util.Map phAttributeList)
                         throws tcFormNotFoundException,
                                tcFormEntryNotFoundException,
                                tcInvalidValueException,
                                tcAPIException,
                                tcAPIException

Updates process data on the child form that is associated with an instance of a process in the system.

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plChildFormPrimaryKey - The primary key of the child table entry to be updated.

phAttributeList - A map of name-value pairs, each entry representing an attribute to be updated in the child form. Note that the attributes must correspond with the version of the child form associated with the process instance.

Throws:

tcFormNotFoundException

tcFormEntryNotFoundException

tcInvalidValueException

tcAPIException - an error code of DOBJ.USR_PASSWORD_DOES_NOT_MATCH_POLICY might be set within this exception. If that's the case, one or many password policy rules were not met for password field in the form.

prepopulateObjectForm

Thor.API.tcResultSet prepopulateObjectForm(long plUserKey,
                                           long plFormDefinitionKey,
                                           java.util.Map phFormValues)
                                    throws tcUserNotFoundException,
                                           tcFormNotFoundException,
                                           tcAPIException,
                                           tcAPIException

Deprecated.

Pre-populates the object form's data based on pre-population rules and adapters.

Parameters:

plUserKey - The user key of the requester.

plFormDefinitionKey - The key of the object form's definition.

phFormValues - A Map containing all the fields of the object form with their existing values.

Returns:

A tcResultSet containing all the fields and values of the object form. The fields that have associated pre-population rules and adapters will have their calculated value. All other fields will maintain their value from phFormValues.

Throws:

tcUserNotFoundException

tcFormNotFoundException

tcAPIException

prepopulateProcessForm

Thor.API.tcResultSet prepopulateProcessForm(long plProcessInstanceKey,
                                            long plFormDefinitionKey,
                                            java.util.Map phFormValues)
                                     throws tcProcessNotFoundException,
                                            tcFormNotFoundException,
                                            tcAPIException,
                                            tcAPIException

Pre-populates the process form's data based on pre-population rules and adapters.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

plFormDefinitionKey - The key of the process form's definition.

phFormValues - A Map containing all the fields of the process form with their existing values.

Returns:

A tcResultSet containing all the fields and values of the process form. The fields that have associated pre-population rules and adapters will have their calculated value in the tcResultSet. The fields without an associated rule and adapter will maintain their value from phFormValues. The resultset, in addition to the process form fields also returns the following columns: are:

• UD_FORMNAME_KEY
• Process Instance.Key
• Access Policies.Key
• UD_FORMNAME_UPDATEBY
• UD_FORMNAME_UPDATE
• UD_FORMNAME_CREATEBY
• UD_FORMNAME_CREATE
• UD_FORMNAME_NOTE
• UD_FORMNAME_ROWVER
• UD_FORMNAME_DATA_LEVEL
• UD_FORMNAME_VERSION

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException