|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcFormInstanceOperationsIntf
Method Summary | |
---|---|
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) Returns information about the child form(s) of the specified parent form. |
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 |
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) Returns the form version with which the process instance was saved. |
Thor.API.tcResultSet |
prepopulateObjectForm(long plUserKey, long plFormDefinitionKey, java.util.Map phFormValues) Pre-populates the object form's data based on pre-population rules and adapters. |
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 |
---|
Thor.API.tcResultSet getProcessFormDataInViewMode(long plProcessInstanceKey) throws tcNotAtomicProcessException, tcFormNotFoundException, tcAPIException, tcProcessNotFoundException, tcAPIException
plProcessInstanceKey
- The key of the process instance in the system.tcNotAtomicProcessException
tcFormNotFoundException
tcAPIException
tcProcessNotFoundException
Thor.API.tcResultSet getProcessFormData(long plProcessInstanceKey) throws tcNotAtomicProcessException, tcFormNotFoundException, tcAPIException, tcProcessNotFoundException, tcAPIException
plProcessInstanceKey
- The key of the process instance in the system.tcNotAtomicProcessException
tcFormNotFoundException
tcAPIException
tcProcessNotFoundException
void setProcessFormData(long plProcessInstanceKey, java.util.Map phAttributeList) throws tcAPIException, tcInvalidValueException, tcNotAtomicProcessException, tcFormNotFoundException, tcRequiredDataMissingException, tcProcessNotFoundException, tcAPIException
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 formtcAPIException
- 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
long getProcessFormDefinitionKey(long plProcessInstanceKey) throws tcProcessNotFoundException, tcFormNotFoundException, tcAPIException, tcAPIException
plProcessInstanceKey
- The key of the object instance in the system.tcProcessNotFoundException
tcFormNotFoundException
tcAPIException
int getActiveVersion(long plFormDefinitionKey) throws tcVersionNotDefinedException, tcFormNotFoundException, tcAPIException, tcAPIException
plFormDefinitionKey
- The form definition key.tcVersionNotDefinedException
tcFormNotFoundException
tcAPIException
int getProcessFormVersion(long plProcessInstanceKey) throws tcNotAtomicProcessException, tcFormNotFoundException, tcVersionNotFoundException, tcAPIException, tcAPIException
plProcessInstanceKey
- The key of the process instance in the system.tcNotAtomicProcessException
tcFormNotFoundException
tcVersionNotFoundException
tcAPIException
Thor.API.tcResultSet getChildFormDefinition(long plParentFormDefinitionKey, int pnParentFormVersion) throws tcFormNotFoundException, tcVersionNotDefinedException, tcAPIException, tcAPIException
plParentFormDefinitionKey
- The key for the parent form definition.pnParentFormVersion
- The version of the parent form to get children for.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.tcFormNotFoundException
tcVersionNotDefinedException
tcAPIException
Thor.API.tcResultSet getProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey) throws tcProcessNotFoundException, tcFormNotFoundException, tcAPIException, tcAPIException
plChildFormDefinitionKey
- The key for the child form definition.plProcessInstanceKey
- The key of the process instance in the system.tcResultSet
with each row containing process data from the child form for the specified process instance.tcProcessNotFoundException
tcFormNotFoundException
tcAPIException
void executeSODCheck(long plProcessInstanceKey) throws tcProcessNotFoundException, tcFormNotFoundException, tcRequiredDataMissingException, tcInvalidValueException, tcNotAtomicProcessException, tcAPIException, tcAPIException
plProcessInstanceKey
- The key of the process instance in the system.tcProcessNotFoundException
tcFormNotFoundException
tcRequiredDataMissingException
tcInvalidValueException
tcNotAtomicProcessException
tcAPIException
long addProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey, java.util.Map phAttributeList, boolean createHolder, boolean createSODChecker) throws tcProcessNotFoundException, tcFormNotFoundException, tcRequiredDataMissingException, tcInvalidValueException, tcNotAtomicProcessException, tcAPIException, tcAPIException
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 nottcProcessNotFoundException
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.long addProcessFormChildData(long plChildFormDefinitionKey, long plProcessInstanceKey, java.util.Map phAttributeList) throws tcProcessNotFoundException, tcFormNotFoundException, tcRequiredDataMissingException, tcInvalidValueException, tcNotAtomicProcessException, tcAPIException, tcAPIException
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.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.void removeProcessFormChildData(long plChildFormDefinitionKey, long plChildFormPrimaryKey) throws tcFormNotFoundException, tcFormEntryNotFoundException, tcAPIException, tcAPIException
plChildFormDefinitionKey
- The key for the child form definition.plChildFormPrimaryKey
- The primary key of the child table entry to be removed.tcFormNotFoundException
tcFormEntryNotFoundException
tcAPIException
void updateProcessFormChildData(long plChildFormDefinitionKey, long plChildFormPrimaryKey, java.util.Map phAttributeList) throws tcFormNotFoundException, tcFormEntryNotFoundException, tcInvalidValueException, tcAPIException, tcAPIException
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.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.Thor.API.tcResultSet prepopulateObjectForm(long plUserKey, long plFormDefinitionKey, java.util.Map phFormValues) throws tcUserNotFoundException, tcFormNotFoundException, tcAPIException, tcAPIException
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.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
.tcUserNotFoundException
tcFormNotFoundException
tcAPIException
Thor.API.tcResultSet prepopulateProcessForm(long plProcessInstanceKey, long plFormDefinitionKey, java.util.Map phFormValues) throws tcProcessNotFoundException, tcFormNotFoundException, tcAPIException, tcAPIException
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.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
.tcProcessNotFoundException
tcFormNotFoundException
tcAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |