Skip navigation links

Thor.API.Operations
Interface tcWorkflowDefinitionOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcWorkflowDefinitionOperationsIntf

extends tcUtilityOperationsIntf

Method Summary

void	addAdministrator(long plWorkflowKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Adds a group to the list of groups that have administrative access over the specified workflow.
void	addAdministrators(long plWorkflowKey, long[] plGroupKeys, boolean[] pbWrite, boolean[] pbDelete) Adds groups to the list of groups that have administrative access over the specified workflow.
void	createProcess(com.thortech.xl.vo.workflow.ProcessDefinition process) Method to create a new workflow
Thor.API.tcResultSet	getAdapterMappings(java.lang.String adpType, long adpKey) Method to get the adapter mappings for an adapter
Thor.API.tcResultSet	getAllRules() This method will retrieve the list of rules in the system
Thor.API.tcResultSet	getAvailableAdapters() Method to get all the available adapters in the system
Thor.API.tcResultSet	getAvailableEventHandlers() Method to get all the available event handlers in the system
Thor.API.tcResultSet	getAvailableTaskAssignmentAdapters() Method to get all the available task assignment adapters in the system
Thor.API.tcResultSet	getChildForms(long parentFormKey, int parentCurrentFormVersion) Method to get all the child forms for a given parent form
java.lang.String	getColumnLength(java.lang.String psTable, java.lang.String psColName) This method will retrieve the column length in the table
Thor.API.tcResultSet	getForms() Method to get all the available forms in the system
Thor.API.tcResultSet	getObjectStatuses(long objectKey) This method will retrieve the object statuses defined on a object
java.util.Vector	getOrgAttributesForTrustedSourceReconMapping() This method will retrieve the organization attributes from org profile to be used for trusted source reconciliation mappings
Thor.API.tcResultSet	getTaskAssignmentRule() Method to get all the task assignment rules in the system
Thor.API.tcResultSet	getTaskAssignmentTypes() This method will retrieve different task assignment types
Thor.API.tcResultSet	getTaskStatusKeyMapping() This method will retrieve the mapping of status key and corresponding status mapping
java.util.Vector	getUserAttributesForTrustedSourceReconMapping() This method will retrieve the user attributes from user profile to be used for trusted source reconciliation mappings
Thor.API.tcResultSet	getUserDefinedFields(java.lang.String formName) Method to get all the user defined fields for a form
com.thortech.xl.vo.workflow.WorkflowDefinition	getWorkflowDefinition(long workflowDefKey) This method will retrieve the definition of a workflow based on the provided workflow definition key.
com.thortech.xl.vo.workflow.WorkflowDefinition	getWorkflowDefinition(java.lang.String workflowName) This method will retrieve the definition of a workflow based on the provided workflow name.
java.lang.String	getWorkflowDefinitionXML(long workflowDefKey) This method will retrieve the XML definition of a workflow based on the provided workflow definition key.
java.lang.String	getWorkflowDefinitionXML(java.lang.String workflowName) This method will retrieve the definition of a workflow based on the provided workflow name in the form of an XML document.
boolean	isWorkflowCreationPermitted() This method will return if the logged in user has permissions to create new workflows
boolean	isWorkflowUpdatePermitted() This method will return if the logged in user has permissions to update existing workflows
void	removeAdministrator(long plWorkflowKey, long plGroupKey) Removes a group from the list of groups that have administrative access over the specified workflow.
void	removeAdministrators(long plWorkflowKey, long[] plGroupKeys) Removes groups from the list of groups that have administrative access over the specified workflow.
void	updateAdministrator(long plWorkflowKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Updates the access permissions an administrative group has over the specified workflow.
void	updateAdministrators(long plProcessKey, long[] plGroupKeys, boolean[] pbWrites, boolean[] pbDeletes) Updates the access permissions administrative groups have over the specified workflow.
void	updateWorkflow(com.thortech.xl.vo.workflow.WorkflowDefinition workflow) Updates and saves a workflow

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

getWorkflowDefinitionXML

java.lang.String getWorkflowDefinitionXML(java.lang.String workflowName)
                                          throws tcAPIException,
                                                 tcAPIException

This method will retrieve the definition of a workflow based on the provided workflow name in the form of an XML document.

Parameters:

psWorkflowName - is the name of the workflow definition

Returns:

The workflow definition XML

Throws:

tcAPIException

getWorkflowDefinition

com.thortech.xl.vo.workflow.WorkflowDefinition getWorkflowDefinition(java.lang.String workflowName)
                                                                     throws tcAPIException,
                                                                            tcAPIException

This method will retrieve the definition of a workflow based on the provided workflow name.

Parameters:

psWorkflowName - is the name of the workflow definition

Returns:

The workflow definition value object

Throws:

tcAPIException

getWorkflowDefinitionXML

java.lang.String getWorkflowDefinitionXML(long workflowDefKey)
                                          throws tcAPIException,
                                                 tcAPIException

This method will retrieve the XML definition of a workflow based on the provided workflow definition key.

Parameters:

workflowDefKey - is the key of the workflow definition

Returns:

The workflow definition XML

Throws:

tcAPIException

getWorkflowDefinition

com.thortech.xl.vo.workflow.WorkflowDefinition getWorkflowDefinition(long workflowDefKey)
                                                                     throws tcAPIException,
                                                                            tcAPIException

This method will retrieve the definition of a workflow based on the provided workflow definition key.

Parameters:

workflowDefKey - is the key of the workflow definition

Returns:

The workflow definition value object

Throws:

tcAPIException

tcPropertyNotFoundException

tcDuplicatePropertyException

createProcess

void createProcess(com.thortech.xl.vo.workflow.ProcessDefinition process)
                   throws tcAPIException,
                          tcAPIException

Method to create a new workflow

Parameters:

process - ProcessDefinition object used to create a new workflow

Throws:

tcAPIException

Since:

9.1.0.0

getForms

Thor.API.tcResultSet getForms()
                              throws tcAPIException,
                                     tcAPIException

Method to get all the available forms in the system

Returns:

A tcResultSet containing multiple rows, each holding information about the forms

Throws:

tcAPIException

Since:

9.1.0.0

getChildForms

Thor.API.tcResultSet getChildForms(long parentFormKey,
                                   int parentCurrentFormVersion)
                                   throws tcAPIException,
                                          tcAPIException

Method to get all the child forms for a given parent form

Parameters:

parentFormKey - key of the parent form

parentCurrentFormVersion - current version of the parent form

Returns:

A tcResultSet containing multiple rows, each holding information about the forms

Throws:

tcAPIException

Since:

9.1.0.0

getAdapterMappings

Thor.API.tcResultSet getAdapterMappings(java.lang.String adpType,
                                        long adpKey)
                                        throws tcAPIException,
                                               tcAPIException

Method to get the adapter mappings for an adapter

Parameters:

adpType - Type of the adapter "T" for Task Adapter and "A" for Task Assignment Adapter

adpKey - key of the adapter

Returns:

A tcResultSet containing multiple rows, each holding information about the adapter mappings

Throws:

tcAPIException

Since:

9.1.0.0

getAvailableEventHandlers

Thor.API.tcResultSet getAvailableEventHandlers()
                                               throws tcAPIException,
                                                      tcAPIException

Method to get all the available event handlers in the system

Returns:

A tcResultSet containing multiple rows, each holding information about the event handlers

Throws:

tcAPIException

Since:

9.1.0.0

getAvailableAdapters

Thor.API.tcResultSet getAvailableAdapters()
                                          throws tcAPIException,
                                                 tcAPIException

Method to get all the available adapters in the system

Returns:

A tcResultSet containing multiple rows, each holding information about the adapters

Throws:

tcAPIException

Since:

9.1.0.0

getAvailableTaskAssignmentAdapters

Thor.API.tcResultSet getAvailableTaskAssignmentAdapters()
                                                        throws tcAPIException,
                                                               tcAPIException

Method to get all the available task assignment adapters in the system

Returns:

A tcResultSet containing multiple rows, each holding information about the task assignment adapters

Throws:

tcAPIException

Since:

9.1.0.0

getUserDefinedFields

Thor.API.tcResultSet getUserDefinedFields(java.lang.String formName)
                                          throws tcAPIException,
                                                 tcAPIException

Method to get all the user defined fields for a form

Returns:

A tcResultSet containing multiple rows, each holding information about the user defined fields

Throws:

tcAPIException

Since:

9.1.0.0

getTaskAssignmentRule

Thor.API.tcResultSet getTaskAssignmentRule()
                                           throws tcAPIException,
                                                  tcAPIException

Method to get all the task assignment rules in the system

Returns:

A tcResultSet containing multiple rows, each holding information about the task assignment rules

Throws:

tcAPIException

Since:

9.1.0.0

updateWorkflow

void updateWorkflow(com.thortech.xl.vo.workflow.WorkflowDefinition workflow)
                    throws tcAPIException,
                           tcAPIException

Updates and saves a workflow

Parameters:

workflow - The workflow definition, an instance of WorkflowDefinition

Throws:

tcAPIException

Since:

9.1.0.0

getTaskStatusKeyMapping

Thor.API.tcResultSet getTaskStatusKeyMapping()
                                             throws tcAPIException,
                                                    tcAPIException

This method will retrieve the mapping of status key and corresponding status mapping

Returns:

The mapping of status and its key value

Throws:

tcAPIException

Since:

9.1.0.0

getObjectStatuses

Thor.API.tcResultSet getObjectStatuses(long objectKey)
                                       throws tcAPIException,
                                              tcAPIException

This method will retrieve the object statuses defined on a object

Returns:

The object status key and value

Throws:

tcAPIException

Since:

9.1.0.0

getAllRules

Thor.API.tcResultSet getAllRules()
                                 throws tcAPIException,
                                        tcAPIException

This method will retrieve the list of rules in the system

Returns:

The object rule name, rule type and rule key

Throws:

tcAPIException

Since:

9.1.0.0

getTaskAssignmentTypes

Thor.API.tcResultSet getTaskAssignmentTypes()
                                            throws tcAPIException,
                                                   tcAPIException

This method will retrieve different task assignment types

Returns:

The task assignment types

Throws:

tcAPIException

Since:

9.1.0.0

isWorkflowCreationPermitted

boolean isWorkflowCreationPermitted()
                                    throws tcAPIException,
                                           tcAPIException

This method will return if the logged in user has permissions to create new workflows

Returns:

boolean true if permitted, false otherwise

Throws:

tcAPIException

Since:

9.1.0.0

isWorkflowUpdatePermitted

boolean isWorkflowUpdatePermitted()
                                  throws tcAPIException,
                                         tcAPIException

This method will return if the logged in user has permissions to update existing workflows

Returns:

boolean true if permitted, false otherwise

Throws:

tcAPIException

Since:

9.1.0.0

addAdministrators

void addAdministrators(long plWorkflowKey,
                       long[] plGroupKeys,
                       boolean[] pbWrite,
                       boolean[] pbDelete)
                       throws tcAdminNotFoundException,
                              tcAPIException,
                              tcProcessNotFoundException,
                              tcGroupNotFoundException,
                              tcAPIException

Adds groups to the list of groups that have administrative access over the specified workflow.

Parameters:

plWorkflowKey - String holding the workflow Key (corresponds to value in the PKG_KEY column)

plGroupKeys - holding the Group Key (corresponds to value in the UGP_KEY column)

pbWrite[] - Whether the group has write access to the workflow

pbDelete[] - Whether the group has delete access to the workflow

Throws:

tcAdminNotFoundException

tcAPIException

tcProcessNotFoundException

tcGroupNotFoundException

Since:

9.1.0.0

addAdministrator

void addAdministrator(long plWorkflowKey,
                      long plGroupKey,
                      boolean pbWrite,
                      boolean pbDelete)
                      throws tcAdminNotFoundException,
                             tcAPIException,
                             tcProcessNotFoundException,
                             tcGroupNotFoundException,
                             tcAPIException

Adds a group to the list of groups that have administrative access over the specified workflow.

Parameters:

plWorkflowKey - String holding the workflow Key (corresponds to value in the PKG_KEY column)

plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)

pbWrite - Whether the group has write access to the workflow

pbDelete - Whether the group has delete access to the workflow

Throws:

tcAdminNotFoundException

tcAPIException

tcProcessNotFoundException

tcGroupNotFoundException

Since:

9.1.0.0

removeAdministrators

void removeAdministrators(long plWorkflowKey,
                          long[] plGroupKeys)
                          throws tcAPIException,
                                 tcAdminNotFoundException,
                                 tcProcessNotFoundException,
                                 tcGroupNotFoundException,
                                 tcAPIException

Removes groups from the list of groups that have administrative access over the specified workflow.

Parameters:

plWorkflowKey - String holding the workflow Key (corresponds to value in the PKG_KEY column)

plGroupKey - [] holding the Group Keys (corresponds to value in the UGP_KEY column)

Throws:

tcAPIException

tcAdminNotFoundException

tcProcessNotFoundException

tcGroupNotFoundException

Since:

9.1.0.0

removeAdministrator

void removeAdministrator(long plWorkflowKey,
                         long plGroupKey)
                         throws tcAPIException,
                                tcAdminNotFoundException,
                                tcProcessNotFoundException,
                                tcGroupNotFoundException,
                                tcAPIException

Removes a group from the list of groups that have administrative access over the specified workflow.

Parameters:

plWorkflowKey - String holding the workflow Key (corresponds to value in the PKG_KEY column)

plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)

Throws:

tcAPIException

tcAdminNotFoundException

tcProcessNotFoundException

tcGroupNotFoundException

Since:

9.1.0.0

updateAdministrators

void updateAdministrators(long plProcessKey,
                          long[] plGroupKeys,
                          boolean[] pbWrites,
                          boolean[] pbDeletes)
                          throws tcAdminNotFoundException,
                                 tcAPIException,
                                 tcProcessNotFoundException,
                                 tcGroupNotFoundException,
                                 tcAPIException

Updates the access permissions administrative groups have over the specified workflow.

Parameters:

plWorkflowKey - String holding the workflow Key

plGroupKey[] - holding the Group Keys

pbWrite[] - Whether the group has write access to the workflow

pbDelete[] - Whether the group has delete access to the workflow

Throws:

tcAdminNotFoundException

tcAPIException

tcProcessNotFoundException

tcGroupNotFoundException

Since:

9.1.0.0

updateAdministrator

void updateAdministrator(long plWorkflowKey,
                         long plGroupKey,
                         boolean pbWrite,
                         boolean pbDelete)
                         throws tcAdminNotFoundException,
                                tcAPIException,
                                tcProcessNotFoundException,
                                tcGroupNotFoundException,
                                tcAPIException

Updates the access permissions an administrative group has over the specified workflow.

Parameters:

plWorkflowKey - String holding the Workflow Key

plGroupKey - String holding the Group Key

pbWrite - Whether the group has write access to the workflow

pbDelete - Whether the group has delete access to the workflow

Throws:

tcAdminNotFoundException

tcAPIException

tcProcessNotFoundException

tcGroupNotFoundException

Since:

9.1.0.0

getUserAttributesForTrustedSourceReconMapping

java.util.Vector getUserAttributesForTrustedSourceReconMapping()
                                                               throws tcAPIException,
                                                                      tcAPIException

This method will retrieve the user attributes from user profile to be used for trusted source reconciliation mappings

Returns:

The vector containing the user attributes

Throws:

tcAPIException

Since:

9.1.0.0

getOrgAttributesForTrustedSourceReconMapping

java.util.Vector getOrgAttributesForTrustedSourceReconMapping()
                                                              throws tcAPIException,
                                                                     tcAPIException

This method will retrieve the organization attributes from org profile to be used for trusted source reconciliation mappings

Returns:

The vector containing the org attributes

Throws:

tcAPIException

Since:

9.1.0.0

getColumnLength

java.lang.String getColumnLength(java.lang.String psTable,
                                 java.lang.String psColName)
                                 throws tcAPIException,
                                        tcAPIException

This method will retrieve the column length in the table

Returns:

The String containing the column length

Throws:

tcAPIException

Since:

9.1.0.0

Skip navigation links