Package com.thortech.xl.vo.workflow
Class ResponseDefinition
java.lang.Object
com.thortech.xl.vo.workflow.ResponseDefinition
- All Implemented Interfaces:
Serializable
- Author:
- nkaushik Represents each response defined for the task. It includes the response code, description and also the list of all generated tasks
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the list of tasks that are generated by the response.getKey()
Returns the Key of the Response DefinitionReturns the Response CodeReturns the Response DescriptionReturns the Status that the Response will set on the TaskReturns the Key of the Status that the Response will set on the Taskvoid
removeGeneratedTask
(String generatedTask) Remove a task from the list of Tasks generated by this responsevoid
setGeneratedTask
(String generatedTask) Add a task to the list of Tasks generated by this responsevoid
setGeneratedTasks
(HashSet generatedTasks) Sets the list of tasks that are generated by the response.void
Sets the Key of the Response Definitionvoid
setResponse
(String response) Sets the Response Codevoid
setResponseDescription
(String responseDescription) Sets the Response Descriptionvoid
setResponseProperties
(ResponseProperties responseProperties) void
Sets the Status that the Response will set on the Taskvoid
setStatusKey
(String statusKey) Sets the Key of the Status that the Response will set on the Task
-
Constructor Details
-
ResponseDefinition
public ResponseDefinition()Constructor
-
-
Method Details
-
getGeneratedTasks
Returns the list of tasks that are generated by the response. The returned string array contains the names of the tasks- Returns:
- The names of the Generated Tasks.
-
setGeneratedTasks
Sets the list of tasks that are generated by the response. The provided hashset should contain the names of the tasks- Parameters:
generatedTasks
- The names of the Generated Tasks.
-
setGeneratedTask
Add a task to the list of Tasks generated by this response- Parameters:
generatedTask
- The name of the task to add.
-
removeGeneratedTask
Remove a task from the list of Tasks generated by this response- Parameters:
generatedTask
- The name of the task to remove.
-
getResponse
Returns the Response Code- Returns:
- The response code.
-
setResponse
Sets the Response Code- Parameters:
response
- The response code to set.
-
getStatus
Returns the Status that the Response will set on the Task- Returns:
- The status.
-
setStatus
Sets the Status that the Response will set on the Task- Parameters:
status
- The status to set.
-
getKey
Returns the Key of the Response Definition- Returns:
- The key.
-
setKey
Sets the Key of the Response Definition- Parameters:
key
- The key.
-
getResponseDescription
Returns the Response Description- Returns:
- The Response Description.
-
setResponseDescription
Sets the Response Description- Parameters:
responseDescription
- The Response Description to set.
-
getStatusKey
Returns the Key of the Status that the Response will set on the Task- Returns:
- The Status Key.
-
setStatusKey
Sets the Key of the Status that the Response will set on the Task- Parameters:
statusKey
- The Status Key to set.
-
getResponseProperties
-
setResponseProperties
-