|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.thortech.xl.vo.workflow.TaskDefinition
public class TaskDefinition
Field Summary | |
---|---|
static int |
CREATE |
static int |
DELETE |
static int |
NO_ACTION |
static int |
UPDATE |
Constructor Summary | |
---|---|
TaskDefinition() Constructor |
Method Summary | |
---|---|
void |
addDependsOnTask(java.lang.String taskName) Add a task to the list of tasks this task depends on |
java.util.HashMap |
getChildOf() |
java.lang.String |
getChildTable() |
java.util.HashSet |
getDependsOn() Returns the list of tasks this task depends on. |
java.lang.String[] |
getDependsOnTaskList() Returns the list of tasks this task depends on. |
java.lang.String |
getDescription() Returns the description of the task |
java.lang.String |
getKey() Returns the Definition Key of the task |
java.lang.String |
getName() Returns the name of the task |
java.util.HashSet |
getNotifications() Returns the list of Email Notifications set up for this task. |
java.lang.String[] |
getRecoveryTasks() Returns the list of Recovery Tasks defined for this task. |
java.util.HashSet |
getRecoveryTasksList() Returns the HashSet of Recovery Tasks defined for this task. |
ResponseDefinition |
getResponseDefinition(java.lang.String response) Returns the Response Definition object defined for this task with the provided Response Code |
java.lang.String[] |
getResponseList() Returns the list of Response Codes for all responses defined for this task |
java.util.HashMap |
getResponses() Returns the list of Responses defined for this task. |
java.lang.String |
getRetryCount() Returns the number of times a rejected instance of this task will be retried |
java.lang.String |
getRetryPeriod() Returns the time period after which a rejected instance of this task will be retried |
java.util.HashMap |
getStatusMappings() Returns the list of Task Status to Object Status Mappings defined for this task. |
java.lang.String |
getTaskAdapter() Returns the name of the task adapter attached to this task |
java.lang.String |
getTaskAdapterKey() Returns the Definition Key (EVT_KEY) of the Adapter or Event Handler attached |
java.util.HashSet |
getTaskAdapterMappings() Returns the list of Task Adapter Mappings defined for this task. |
java.lang.String |
getTaskAdapterStatus() Returns the attachment status of the attached adapter |
TaskAssignment |
getTaskAssignment(int priority) Returns the Task Assignment Rule defined for this task with the provided priority |
java.util.HashMap |
getTaskAssignments() Returns a list of Task Assignment Rules defined for this task. |
java.lang.String |
getTaskEffect() Returns the Task Effect of this task |
java.lang.String |
getTaskEffectField() Returns the name of the form field for which this task is a listener |
java.lang.String |
getTriggerType() |
java.lang.String[] |
getUndoTasks() Returns the list of Undo Tasks defined for this task. |
java.util.HashSet |
getUndoTasksList() Returns the HashSet of Undo Tasks defined for this task. |
int |
getUpdateAction() |
java.util.HashSet |
getWorkflowsPresent() |
boolean |
isAllowMultiple() Returns whether the task is allowed to be inserted multiple times into the same workflow instance |
boolean |
isAutomated() Returns whether the task is automated or not. |
boolean |
isCancelWhilePending() Returns whether the task is allowed to be cancelled while still in pending state |
boolean |
isCompleteOnRecovery() Returns whether the task should Complete on Recovery Tasks completion |
boolean |
isConditionalTask() Returns whether the task is a conditional task or not |
boolean |
isEventHandler() |
boolean |
isManualInsertNotAllowed() Returns whether the task can be manually inserted into a workflow or not |
boolean |
isOfflined() |
boolean |
isRemovedTask() |
boolean |
isRequiredComplete() Returns whether the task is required to be complete for workflow completion or not |
boolean |
isTaskInstancePresent() |
boolean |
isTaskNameUpdatable() |
boolean |
isTaskNotRemovable() |
void |
removeDependsOnTask(java.lang.String taskName) Remove a task from the list of tasks this task depends on |
void |
removeNotification(EmailNotification notification) Removes an Email Notification from the list of notifications set up for this task |
void |
removeTaskAssignment(int priority) Remove the task assignment rule attached with the provided priority |
void |
removeUndoTask(java.lang.String undoTask) Removes a task from the list of Undo Tasks |
void |
setAllowMultiple(boolean allowMultiple) Sets whether the task is allowed to be inserted multiple times into the same workflow instance |
void |
setCancelWhilePending(boolean cancelWhilePending) Sets whether the task is allowed to be cancelled while still in pending state |
void |
setChildOf(java.util.HashMap childOf) |
void |
setChildTable(java.lang.String childTable) |
void |
setCompleteOnRecovery(boolean completeOnRecovery) Set whether the task should Complete on Recovery Tasks completion |
void |
setConditionalTask(boolean conditionalTask) Sets whether the task is a conditional task or not |
void |
setDependsOn(java.util.HashSet dependsOn) Sets the list of tasks this task depends on. |
void |
setDescription(java.lang.String description) Sets the description of the task |
void |
setEventHandler(boolean isEventHandler) |
void |
setKey(java.lang.String key) Sets the Definition Key of the task |
void |
setManualInsertNotAllowed(boolean manualInsertNotAllowed) Sets whether the task can be manually inserted into a workflow or not |
void |
setName(java.lang.String name) Sets the name of the task |
void |
setNotification(EmailNotification notification) Adds an Email Notification to the list of notifications set up for this task. |
void |
setNotifications(java.util.HashSet notifications) Sets the list of Email Notifications set up for this task. |
void |
setOfflined(boolean offlined) |
void |
setRecoveryTask(java.lang.String recoveryTask) Add a task to the list of Recovery Tasks |
void |
setRecoveryTasks(java.lang.String[] recoveryTaskList) Sets the list of Recovery Tasks defined for this task. |
void |
setRemovedTask(boolean removedTask) |
void |
setRequiredComplete(boolean requiredComplete) Sets whether the task is required to be complete for workflow completion or not |
void |
setResponse(java.lang.String response, ResponseDefinition responseDefinition) Add a new Response Definition to the list of Responses defined for this task. |
void |
setResponses(java.util.HashMap responses) Sets the list of Responses defined for this task. |
void |
setRetryCount(java.lang.String retryCount) Sets the number of times a rejected instance of this task will be retried |
void |
setRetryPeriod(java.lang.String retryPeriod) Sets the time period after which a rejected instance of this task will be retried |
void |
setStatusMapping(StatusMapping statusMapping) Adds a Task Status to Object Status Mapping to the list defined for this task. |
void |
setStatusMappings(java.util.HashMap statusMappings) Sets the list of Task Status to Object Status Mappings defined for this task. |
void |
setTaskAdapter(java.lang.String taskAdapter) Sets the name of the task adapter attached to this task |
void |
setTaskAdapterKey(java.lang.String taskAdapterKey) Sets the Definition Key (EVT_KEY) of the Adapter or Event Handler attached |
void |
setTaskAdapterMapping(AdapterMapping adapterMapping) Add a Task Adapter Mapping (@see AdapterMapping) to the list of Adapter Mappings defined for this task |
void |
setTaskAdapterMappings(java.util.HashSet taskAdapterMappings) Sets the list of Task Adapter Mappings defined for this task. |
void |
setTaskAdapterStatus(java.lang.String taskAdapterStatus) Sets the attachment status of the attached adapter |
void |
setTaskAssignment(int priority, TaskAssignment taskAssignment) Add a Task Assignment Rule to this task. |
void |
setTaskAssignments(java.util.HashMap taskAssignments) Sets the list of Task Assignment Rules defined for this task. |
void |
setTaskEffect(java.lang.String taskEffect) Sets the Task Effect of this task |
void |
setTaskEffectField(java.lang.String taskEffectField) Sets the name of the form field for which this task is a listener |
void |
setTaskInstancePresent(boolean isTaskInstancePresent) |
void |
setTaskNameUpdatable(boolean taskNameUpdatable) |
void |
setTaskNotRemovable(boolean taskNotRemovable) |
void |
setTriggerType(java.lang.String triggerType) |
void |
setUndoTask(java.lang.String undoTask) Add a task to the list of Undo Tasks |
void |
setUndoTasks(java.lang.String[] undoTaskList) Sets the list of Undo Tasks defined for this task. |
void |
setUpdateAction(int updateAction) |
void |
setWorkflowsPresent(java.util.HashSet workflowsPresent) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_ACTION
public static final int UPDATE
public static final int CREATE
public static final int DELETE
Constructor Detail |
---|
public TaskDefinition()
Method Detail |
---|
public java.util.HashSet getDependsOn()
public java.lang.String[] getDependsOnTaskList()
public void setDependsOn(java.util.HashSet dependsOn)
dependsOn
- The list of task names this task depends on.public void addDependsOnTask(java.lang.String taskName)
taskName
- The name of the task this task depends on.public void removeDependsOnTask(java.lang.String taskName)
taskName
- The name of the task to remove from the list.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- The description.public java.lang.String getName()
public void setName(java.lang.String name)
name
- The name.public java.util.HashSet getNotifications()
public void setNotifications(java.util.HashSet notifications)
notifications
- The list of notifications.public void setNotification(EmailNotification notification)
notification
- The notification to add.public void removeNotification(EmailNotification notification)
notification
- The notifications to remove.public java.util.HashMap getResponses()
objects as the values
public ResponseDefinition getResponseDefinition(java.lang.String response)
The
- response codepublic java.lang.String[] getResponseList()
public void setResponses(java.util.HashMap responses)
responses
- The list of responses to set.objects as the values
public void setResponse(java.lang.String response, ResponseDefinition responseDefinition)
response
- The response code of the response.responseDefinition
- The Response Definition of the response to add @see ResponseDefinitionpublic java.util.HashMap getStatusMappings()
public void setStatusMappings(java.util.HashMap statusMappings)
statusMappings
- The list of statusMappings to set.public void setStatusMapping(StatusMapping statusMapping)
statusMapping
- The StatusMapping to add @see StatusMappingpublic java.lang.String getTaskAdapter()
public void setTaskAdapter(java.lang.String taskAdapter)
taskAdapter
- The name of the Task Adapter.public java.util.HashSet getTaskAdapterMappings()
public void setTaskAdapterMappings(java.util.HashSet taskAdapterMappings)
taskAdapterMappings
- The list of Task Adapter Mappings to set.public void setTaskAdapterMapping(AdapterMapping adapterMapping)
taskAdapterMapping
- The TaskAdapterMapping to set (@see AdapterMapping).public java.util.HashMap getTaskAssignments()
public TaskAssignment getTaskAssignment(int priority)
priority
- The priority of the Assignment Rule to retrievepublic void setTaskAssignments(java.util.HashMap taskAssignments)
taskAssignments
- The list of Task Assignments to set.public void setTaskAssignment(int priority, TaskAssignment taskAssignment)
priority
- The priority with which this assignment rule is defined for this tasktaskAssignment
- The Task Assignment rule to add.public void removeTaskAssignment(int priority)
priority
- The priority of the Task Assignment rule to remove.public java.lang.String[] getUndoTasks()
public java.util.HashSet getUndoTasksList()
public void setUndoTasks(java.lang.String[] undoTaskList)
undoTaskList
- The list of Undo Tasks to set.public void setUndoTask(java.lang.String undoTask)
undoTask
- The Task to set as an Undo Task.public void removeUndoTask(java.lang.String undoTask)
undoTask
- The Task to remove from Undo Task.public java.lang.String[] getRecoveryTasks()
public java.util.HashSet getRecoveryTasksList()
public void setRecoveryTasks(java.lang.String[] recoveryTaskList)
recoveryTaskList
- The list of Recovery Tasks to set.public void setRecoveryTask(java.lang.String recoveryTask)
recoveryTask
- The Task to set as a Recovery Task.public boolean isCompleteOnRecovery()
public void setCompleteOnRecovery(boolean completeOnRecovery)
completeOnRecovery
- True if it should recover, False if not.public java.lang.String getKey()
public void setKey(java.lang.String key)
key
- The key to set.public boolean isAutomated()
public java.lang.String getTaskAdapterKey()
public void setTaskAdapterKey(java.lang.String taskAdapterKey)
taskAdapterKey
- The Key of the Adapter/Event Handler attached.public boolean isAllowMultiple()
public void setAllowMultiple(boolean allowMultiple)
allowMultiple
- True if allowed, False if notpublic boolean isCancelWhilePending()
public void setCancelWhilePending(boolean cancelWhilePending)
cancelWhilePending
- True if allowed, False if notpublic boolean isConditionalTask()
public void setConditionalTask(boolean conditionalTask)
conditionalTask
- True if conditional, False if notpublic boolean isManualInsertNotAllowed()
public void setManualInsertNotAllowed(boolean manualInsertNotAllowed)
manualInsertNotAllowed
- True if not allowed, False if it is allowedpublic boolean isRequiredComplete()
public void setRequiredComplete(boolean requiredComplete)
requiredComplete
- True if required, False if notpublic java.lang.String getRetryCount()
public void setRetryCount(java.lang.String retryCount)
retryCount
- The number if times task will be retriedpublic java.lang.String getRetryPeriod()
public void setRetryPeriod(java.lang.String retryPeriod)
retryPeriod
- The Retry Period to set.public java.lang.String getTaskEffect()
public void setTaskEffect(java.lang.String taskEffect)
taskEffect
- The Task Effect to set.public java.lang.String getTaskEffectField()
public void setTaskEffectField(java.lang.String taskEffectField)
taskEffectField
- The name of the Form Field to set.public java.lang.String getTaskAdapterStatus()
public void setTaskAdapterStatus(java.lang.String taskAdapterStatus)
taskAdapterStatus
- The Task Adapter Attachment Status.public java.lang.String getTriggerType()
public void setTriggerType(java.lang.String triggerType)
triggerType
- The triggerType to set.public java.lang.String getChildTable()
public void setChildTable(java.lang.String childTable)
childTable
- The childTable to set.public int getUpdateAction()
public void setUpdateAction(int updateAction)
updateAction
- The updateAction to set.public java.util.HashSet getWorkflowsPresent()
public void setWorkflowsPresent(java.util.HashSet workflowsPresent)
public boolean isRemovedTask()
public void setRemovedTask(boolean removedTask)
public java.util.HashMap getChildOf()
public void setChildOf(java.util.HashMap childOf)
public boolean isTaskNameUpdatable()
public void setTaskNameUpdatable(boolean taskNameUpdatable)
public boolean isTaskNotRemovable()
public void setTaskNotRemovable(boolean taskNotRemovable)
public boolean isEventHandler()
public void setEventHandler(boolean isEventHandler)
public boolean isTaskInstancePresent()
public void setTaskInstancePresent(boolean isTaskInstancePresent)
public boolean isOfflined()
public void setOfflined(boolean offlined)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |