Thor.API.Operations
Interface tcWorkflowDefinitionOperationsIntf

public interface tcWorkflowDefinitionOperationsIntf

Method Summary

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.

Method Detail

getWorkflowDefinitionXML

public java.lang.String getWorkflowDefinitionXML(java.lang.String workflowName)
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 tcAPIException

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

Returns:

The workflow definition XML

Throws:

tcAPIException

getWorkflowDefinition

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

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

Returns:

The workflow definition value object

Throws:

tcAPIException

getWorkflowDefinitionXML

public java.lang.String getWorkflowDefinitionXML(long workflowDefKey)
                                          throws Thor.API.Exceptions.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

public com.thortech.xl.vo.workflow.WorkflowDefinition getWorkflowDefinition(long workflowDefKey)
                                                                     throws Thor.API.Exceptions.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