Skip navigation links

com.thortech.xl.vo.workflow
Class WorkflowDefinition

java.lang.Object
com.thortech.xl.vo.workflow.WorkflowDefinition

All Implemented Interfaces:

java.io.Serializable

public class WorkflowDefinition

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

WorkflowDefinition()

Method Summary

java.util.HashMap	getDeletedTasks()
java.lang.String	getDescription() Returns the Workflow Description
java.lang.String	getKey() Returns the Workflow Definition Key.
java.lang.String	getModifiedName()
java.lang.String	getName() Returns the workflow name.
java.lang.String	getResource() Returns the name of the resource this workflow is defined for.
java.lang.String	getResourceFormKey()
java.lang.String	getResourceKey() Returns the Definition Key of the Resource this workflow is defined for
java.lang.String	getTable() Returns the name of the Process Form (table) attached to this workflow (if any).
java.lang.String	getTableKey() Returns the Definition Key of the Process Form (Table) attached to this workflow
TaskDefinition	getTask(java.lang.String taskName) Returns the definition of a particular task.
java.util.ArrayList	getTaskList()
java.util.List	getTaskNames()
java.util.HashMap	getTasks() Returns the set of Tasks defined in this workflow in the form of a HashMap.
java.lang.String	getTosKey()
java.lang.String	getType() Returns the Workflow Type
boolean	isAutoPrePopulate() Returns whether the Auto Pre-populate attribute is enabled or not
boolean	isAutoSave() Returns whether the Auto-Save attribute is enabled or not
boolean	isDefaultWorkflow() Returns whether the workflow is the default workflow of its type for the resource it is defined for or not
void	setAutoPrePopulate(boolean autoPrePopulate) Sets whether the Auto Pre-populate attribute is enabled or not
void	setAutoSave(boolean autoSave) Sets whether the Auto-Save attribute is enabled or not
void	setDefaultWorkflow(boolean defaultWorkflow) Sets whether the workflow is the default workflow of its type for the resource it is defined for or not
void	setDeletedTasks(java.util.HashMap deletedTasks)
void	setDescription(java.lang.String description) Sets the Workflow Description
void	setKey(java.lang.String key) Sets the Workflow Definition Key.
void	setModifiedName(java.lang.String modifiedName)
void	setName(java.lang.String name) Sets the workflow name.
void	setResource(java.lang.String resource) Sets the name of the resource this workflow is defined for.
void	setResourceFormKey(java.lang.String resourceFormKey)
void	setResourceKey(java.lang.String resourceKey) Sets the Definition Key of the Resource this workflow is defined for
void	setTable(java.lang.String table) Sets the name of the Process Form (table) attached to this workflow (if any).
void	setTableKey(java.lang.String tableKey) Sets the Definition Key of the Process Form (Table) attached to this workflow
void	setTask(TaskDefinition task) Add the definition of a task in the process to this workflow definition
void	setTaskList(java.util.ArrayList taskList)
void	setTaskNames(java.util.List taskNames)
void	setTasks(java.util.HashMap tasks) Sets the list of tasks defined in this workflow in the form of a HashMap.
void	setTosKey(java.lang.String tosKey)
void	setType(java.lang.String type) Sets the Workflow Type

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowDefinition

public WorkflowDefinition()

Method Detail

getName

public java.lang.String getName()

Returns the workflow name.

Returns:

The workflow name.

setName

public void setName(java.lang.String name)

Sets the workflow name.

Parameters:

name - The workflow name.

getResource

public java.lang.String getResource()

Returns the name of the resource this workflow is defined for.

Returns:

The name of the resource this workflow is defined for.

setResource

public void setResource(java.lang.String resource)

Sets the name of the resource this workflow is defined for.

Parameters:

resource - The name of the resource this workflow is defined for.

getTable

public java.lang.String getTable()

Returns the name of the Process Form (table) attached to this workflow (if any).

Returns:

The name of the Process Form (table) attached to this workflow (if any), or an empty string.

setTable

public void setTable(java.lang.String table)

Sets the name of the Process Form (table) attached to this workflow (if any).

Parameters:

table - The name of the Process Form (table) attached to this workflow (if any).

getTasks

public java.util.HashMap getTasks()

Returns the set of Tasks defined in this workflow in the form of a HashMap. In the HashMap, the task name is the key, and the @see TaskDefinition object is the value.

Returns:

HashMap of all tasks in the workflow.

getTask

public TaskDefinition getTask(java.lang.String taskName)

Returns the definition of a particular task.

Parameters:

The - name of the task to retrieve

Returns:

The definition of the requested task.

setTasks

public void setTasks(java.util.HashMap tasks)

Sets the list of tasks defined in this workflow in the form of a HashMap. In the HashMap, the task name should be the key, and the corresponding @see TaskDefinition object should be the value.

Parameters:

tasks - The tasks to set.

setTask

public void setTask(TaskDefinition task)

Add the definition of a task in the process to this workflow definition

Parameters:

task - The task to add/update in the Workflow definition.

getKey

public java.lang.String getKey()

Returns the Workflow Definition Key. This corresponds to the PKG_KEY value

Returns:

Returns the key.

setKey

public void setKey(java.lang.String key)

Sets the Workflow Definition Key. This corresponds to the PKG_KEY value

Parameters:

key - The key to set.

getResourceKey

public java.lang.String getResourceKey()

Returns the Definition Key of the Resource this workflow is defined for

Returns:

The Resource Definition Key.

setResourceKey

public void setResourceKey(java.lang.String resourceKey)

Sets the Definition Key of the Resource this workflow is defined for

Parameters:

resourceKey - The Resource Definition Key to set.

getTableKey

public java.lang.String getTableKey()

Returns the Definition Key of the Process Form (Table) attached to this workflow

Returns:

The Table Definition Key.

setTableKey

public void setTableKey(java.lang.String tableKey)

Sets the Definition Key of the Process Form (Table) attached to this workflow

Parameters:

tableKey - The Table Definition Key to set.

getDescription

public java.lang.String getDescription()

Returns the Workflow Description

Returns:

The description.

setDescription

public void setDescription(java.lang.String description)

Sets the Workflow Description

Parameters:

description - The description to set.

isAutoPrePopulate

public boolean isAutoPrePopulate()

Returns whether the Auto Pre-populate attribute is enabled or not

Returns:

True is Auto Pre-populate is enabled, False if not.

setAutoPrePopulate

public void setAutoPrePopulate(boolean autoPrePopulate)

Sets whether the Auto Pre-populate attribute is enabled or not

Parameters:

autoPrePopulate - True if Auto Pre-populate is enabled, False if not.

isAutoSave

public boolean isAutoSave()

Returns whether the Auto-Save attribute is enabled or not

Returns:

True if Auto-Save is enabled, False if not.

setAutoSave

public void setAutoSave(boolean autoSave)

Sets whether the Auto-Save attribute is enabled or not

Parameters:

autoSave - True if Auto-Save is enabled, False if not.

getType

public java.lang.String getType()

Returns the Workflow Type

Returns:

The type.

setType

public void setType(java.lang.String type)

Sets the Workflow Type

Parameters:

type - The type.

isDefaultWorkflow

public boolean isDefaultWorkflow()

Returns whether the workflow is the default workflow of its type for the resource it is defined for or not

Returns:

Returns True if it is the default workflow, False if not.

setDefaultWorkflow

public void setDefaultWorkflow(boolean defaultWorkflow)

Sets whether the workflow is the default workflow of its type for the resource it is defined for or not

Parameters:

defaultWorkflow - True if it is the default workflow, False if not.

getTosKey

public java.lang.String getTosKey()

Returns:

Returns the tosKey.

setTosKey

public void setTosKey(java.lang.String tosKey)

Parameters:

tosKey - The tosKey to set.

getTaskNames

public java.util.List getTaskNames()

Returns:

Returns the taskNames.

setTaskNames

public void setTaskNames(java.util.List taskNames)

Parameters:

taskNames - The taskNames to set.

getModifiedName

public java.lang.String getModifiedName()

setModifiedName

public void setModifiedName(java.lang.String modifiedName)

getTaskList

public java.util.ArrayList getTaskList()

setTaskList

public void setTaskList(java.util.ArrayList taskList)

getResourceFormKey

public java.lang.String getResourceFormKey()

setResourceFormKey

public void setResourceFormKey(java.lang.String resourceFormKey)

getDeletedTasks

public java.util.HashMap getDeletedTasks()

setDeletedTasks

public void setDeletedTasks(java.util.HashMap deletedTasks)

Skip navigation links