Thor.API.Operations
Interface tcFormInstanceOperationsIntf

public interface tcFormInstanceOperationsIntf

Method Summary

long	addObjectFormChildData(long plChildFormDefinitionKey, long plObjectInstanceKey, java.util.Map phAttributeList) Adds object data to the child form that is associated with an instance of an object in the system.
long	addObjectFormChildData(long plChildFormDefinitionKey, long plObjectInstanceKey, java.util.Map phAttributeList, boolean startProvisioning) Adds object data to the child form that is associated with an instance of an object in the system.
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.
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	getObjectFormChildData(long plChildFormDefinitionKey, long plObjectInstanceKey) Returns the object data that is saved in a child form and associated with an instance of an object in the system.
Thor.API.tcResultSet	getObjectFormData(long plObjectInstanceKey) Returns the object data associated with an instance of an object in the system.
long	getObjectFormDefinitionKey(long plObjectInstanceKey) Returns the form definition key associated with an instance of an object in the system.
int	getObjectFormVersion(long plObjectInstanceKey) Returns the form version with which the object instance was saved.
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	removeObjectFormChildData(long plChildFormDefinitionKey, long plChildFormPrimaryKey) Removes object data from the child form that is associated with an instance of an object in the system.
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	setObjectFormData(long plObjectInstanceKey, java.util.Map phAttributeList) Sets the object data associated with an instance of an object in the system.
void	setObjectFormData(long plObjectInstanceKey, java.util.Map phAttributeList, boolean startProvisioning) Sets the object data associated with an instance of an object 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	updateObjectFormChildData(long plChildFormDefinitionKey, long plChildFormPrimaryKey, java.util.Map phAttributeList) Updates object data on the child form that is associated with an instance of an object 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.

Method Detail

getObjectFormData

public Thor.API.tcResultSet getObjectFormData(long plObjectInstanceKey)
                                       throws Thor.API.Exceptions.tcObjectNotFoundException,
                                              Thor.API.Exceptions.tcFormNotFoundException,
                                              Thor.API.Exceptions.tcAPIException,
                                              tcAPIException

Returns the object data associated with an instance of an object in the system. If the object 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:

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

Returns:

A tcResultSet containing one row, holding data for the object instance

Throws:

tcObjectNotFoundException

tcFormNotFoundException

tcAPIException

setObjectFormData

public void setObjectFormData(long plObjectInstanceKey,
                              java.util.Map phAttributeList)
                       throws Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcInvalidValueException,
                              Thor.API.Exceptions.tcRequiredDataMissingException,
                              Thor.API.Exceptions.tcObjectNotFoundException,
                              Thor.API.Exceptions.tcFormNotFoundException,
                              tcAPIException

Sets the object data associated with an instance of an object in the system. If the object data 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:

plObjectInstanceKey - The key of the object 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

tcInvalidValueException

tcRequiredDataMissingException

tcObjectNotFoundException

tcFormNotFoundException

setObjectFormData

public void setObjectFormData(long plObjectInstanceKey,
                              java.util.Map phAttributeList,
                              boolean startProvisioning)
                       throws Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcInvalidValueException,
                              Thor.API.Exceptions.tcRequiredDataMissingException,
                              Thor.API.Exceptions.tcObjectNotFoundException,
                              Thor.API.Exceptions.tcFormNotFoundException,
                              tcAPIException

Sets the object data associated with an instance of an object in the system. If the object data 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:

plObjectInstanceKey - The key of the object 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

tcInvalidValueException

tcRequiredDataMissingException

tcObjectNotFoundException

tcFormNotFoundException

getProcessFormDataInViewMode

public Thor.API.tcResultSet getProcessFormDataInViewMode(long plProcessInstanceKey)
                                                  throws Thor.API.Exceptions.tcNotAtomicProcessException,
                                                         Thor.API.Exceptions.tcFormNotFoundException,
                                                         Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.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

Throws:

tcNotAtomicProcessException

tcFormNotFoundException

tcAPIException

tcProcessNotFoundException

getProcessFormData

public Thor.API.tcResultSet getProcessFormData(long plProcessInstanceKey)
                                        throws Thor.API.Exceptions.tcNotAtomicProcessException,
                                               Thor.API.Exceptions.tcFormNotFoundException,
                                               Thor.API.Exceptions.tcAPIException,
                                               Thor.API.Exceptions.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

Throws:

tcNotAtomicProcessException

tcFormNotFoundException

tcAPIException

tcProcessNotFoundException

setProcessFormData

public void setProcessFormData(long plProcessInstanceKey,
                               java.util.Map phAttributeList)
                        throws Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcInvalidValueException,
                               Thor.API.Exceptions.tcNotAtomicProcessException,
                               Thor.API.Exceptions.tcFormNotFoundException,
                               Thor.API.Exceptions.tcRequiredDataMissingException,
                               Thor.API.Exceptions.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

getObjectFormDefinitionKey

public long getObjectFormDefinitionKey(long plObjectInstanceKey)
                                throws Thor.API.Exceptions.tcObjectNotFoundException,
                                       Thor.API.Exceptions.tcFormNotFoundException,
                                       Thor.API.Exceptions.tcAPIException,
                                       tcAPIException

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

Parameters:

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

Returns:

The form defintion key for the specified object instance.

Throws:

tcObjectNotFoundException

tcFormNotFoundException

tcAPIException

getProcessFormDefinitionKey

public long getProcessFormDefinitionKey(long plProcessInstanceKey)
                                 throws Thor.API.Exceptions.tcProcessNotFoundException,
                                        Thor.API.Exceptions.tcFormNotFoundException,
                                        Thor.API.Exceptions.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 specified process instance.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException

getActiveVersion

public int getActiveVersion(long plFormDefinitionKey)
                     throws Thor.API.Exceptions.tcVersionNotDefinedException,
                            Thor.API.Exceptions.tcFormNotFoundException,
                            Thor.API.Exceptions.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

public int getProcessFormVersion(long plProcessInstanceKey)
                          throws Thor.API.Exceptions.tcNotAtomicProcessException,
                                 Thor.API.Exceptions.tcFormNotFoundException,
                                 Thor.API.Exceptions.tcVersionNotFoundException,
                                 Thor.API.Exceptions.tcAPIException,
                                 tcAPIException

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

getObjectFormVersion

public int getObjectFormVersion(long plObjectInstanceKey)
                         throws Thor.API.Exceptions.tcObjectNotFoundException,
                                Thor.API.Exceptions.tcFormNotFoundException,
                                Thor.API.Exceptions.tcVersionNotFoundException,
                                Thor.API.Exceptions.tcAPIException,
                                tcAPIException

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

Parameters:

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

Returns:

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

Throws:

tcObjectNotFoundException

tcFormNotFoundException

tcVersionNotFoundException

tcAPIException

getChildFormDefinition

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

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.

Throws:

tcFormNotFoundException

tcVersionNotDefinedException

tcAPIException

getObjectFormChildData

public Thor.API.tcResultSet getObjectFormChildData(long plChildFormDefinitionKey,
                                                   long plObjectInstanceKey)
                                            throws Thor.API.Exceptions.tcObjectNotFoundException,
                                                   Thor.API.Exceptions.tcFormNotFoundException,
                                                   Thor.API.Exceptions.tcAPIException,
                                                   tcAPIException

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

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

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

Returns:

A tcResultSet with each row containing object data from the child form for the specified object instance.

Throws:

tcObjectNotFoundException

tcFormNotFoundException

tcAPIException

getProcessFormChildData

public Thor.API.tcResultSet getProcessFormChildData(long plChildFormDefinitionKey,
                                                    long plProcessInstanceKey)
                                             throws Thor.API.Exceptions.tcProcessNotFoundException,
                                                    Thor.API.Exceptions.tcFormNotFoundException,
                                                    Thor.API.Exceptions.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.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException

addObjectFormChildData

public long addObjectFormChildData(long plChildFormDefinitionKey,
                                   long plObjectInstanceKey,
                                   java.util.Map phAttributeList)
                            throws Thor.API.Exceptions.tcObjectNotFoundException,
                                   Thor.API.Exceptions.tcFormNotFoundException,
                                   Thor.API.Exceptions.tcRequiredDataMissingException,
                                   Thor.API.Exceptions.tcInvalidValueException,
                                   Thor.API.Exceptions.tcAPIException,
                                   tcAPIException

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

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plObjectInstanceKey - The key of the object 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 object instance.

Returns:

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

Throws:

tcObjectNotFoundException

tcFormNotFoundException

tcRequiredDataMissingException

tcInvalidValueException

tcAPIException

addObjectFormChildData

public long addObjectFormChildData(long plChildFormDefinitionKey,
                                   long plObjectInstanceKey,
                                   java.util.Map phAttributeList,
                                   boolean startProvisioning)
                            throws Thor.API.Exceptions.tcObjectNotFoundException,
                                   Thor.API.Exceptions.tcFormNotFoundException,
                                   Thor.API.Exceptions.tcRequiredDataMissingException,
                                   Thor.API.Exceptions.tcInvalidValueException,
                                   Thor.API.Exceptions.tcAPIException,
                                   tcAPIException

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

Parameters:

plChildFormDefinitionKey - The key for the child form definition.

plObjectInstanceKey - The key of the object 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 object instance.

Returns:

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

Throws:

tcObjectNotFoundException

tcFormNotFoundException

tcRequiredDataMissingException

tcInvalidValueException

tcAPIException

addProcessFormChildData

public long addProcessFormChildData(long plChildFormDefinitionKey,
                                    long plProcessInstanceKey,
                                    java.util.Map phAttributeList)
                             throws Thor.API.Exceptions.tcProcessNotFoundException,
                                    Thor.API.Exceptions.tcFormNotFoundException,
                                    Thor.API.Exceptions.tcRequiredDataMissingException,
                                    Thor.API.Exceptions.tcInvalidValueException,
                                    Thor.API.Exceptions.tcNotAtomicProcessException,
                                    Thor.API.Exceptions.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.

removeObjectFormChildData

public void removeObjectFormChildData(long plChildFormDefinitionKey,
                                      long plChildFormPrimaryKey)
                               throws Thor.API.Exceptions.tcFormNotFoundException,
                                      Thor.API.Exceptions.tcFormEntryNotFoundException,
                                      Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Removes object data from the child form that is associated with an instance of an object 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

removeProcessFormChildData

public void removeProcessFormChildData(long plChildFormDefinitionKey,
                                       long plChildFormPrimaryKey)
                                throws Thor.API.Exceptions.tcFormNotFoundException,
                                       Thor.API.Exceptions.tcFormEntryNotFoundException,
                                       Thor.API.Exceptions.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

updateObjectFormChildData

public void updateObjectFormChildData(long plChildFormDefinitionKey,
                                      long plChildFormPrimaryKey,
                                      java.util.Map phAttributeList)
                               throws Thor.API.Exceptions.tcFormNotFoundException,
                                      Thor.API.Exceptions.tcFormEntryNotFoundException,
                                      Thor.API.Exceptions.tcInvalidValueException,
                                      Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Updates object data on the child form that is associated with an instance of an object 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 object instance.

Throws:

tcFormNotFoundException

tcFormEntryNotFoundException

tcInvalidValueException

tcAPIException

updateProcessFormChildData

public void updateProcessFormChildData(long plChildFormDefinitionKey,
                                       long plChildFormPrimaryKey,
                                       java.util.Map phAttributeList)
                                throws Thor.API.Exceptions.tcFormNotFoundException,
                                       Thor.API.Exceptions.tcFormEntryNotFoundException,
                                       Thor.API.Exceptions.tcInvalidValueException,
                                       Thor.API.Exceptions.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

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

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

public Thor.API.tcResultSet prepopulateProcessForm(long plProcessInstanceKey,
                                                   long plFormDefinitionKey,
                                                   java.util.Map phFormValues)
                                            throws Thor.API.Exceptions.tcProcessNotFoundException,
                                                   Thor.API.Exceptions.tcFormNotFoundException,
                                                   Thor.API.Exceptions.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.

Throws:

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException