|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface WorkflowRepository
A repository interface for obtaining Workflows, and managing the
information about their WorkflowTasks.
| Method Summary | |
|---|---|
List |
getConditionsByTaskId(String taskId)
Returns an ordered List of WorkflowConditions associated
with the given taskId. |
List |
getConditionsByTaskName(String taskName)
Returns an ordered List of WorkflowConditions associated with the given taskName. |
WorkflowTaskConfiguration |
getConfigurationByTaskId(String taskId)
Gets the WorkflowTaskConfiguration metadata for the
WorkflowTask with the given taskId. |
List |
getRegisteredEvents()
Gets a List of Events that are registered in the
Workflow Manager as having valid Workflows mapped to their
names. |
List |
getTasksByWorkflowId(String workflowId)
Returns a List of WorkflowTasks associated with the
specified Workflow identified by its workflowId. |
List |
getTasksByWorkflowName(String workflowName)
Returns a List of WorkflowTasks associated with the
specified Workflow identified by its workflowName. |
Workflow |
getWorkflowById(String workflowId)
Returns a Workflow with the given workflowId. |
Workflow |
getWorkflowByName(String workflowName)
Returns a Workflow with the given workflowName. |
WorkflowCondition |
getWorkflowConditionById(String conditionId)
Returns the WorkflowCondition with the given conditionId. |
List |
getWorkflows()
Gets all Workflows from the repository. |
List |
getWorkflowsForEvent(String eventName)
Returns a List of Workflows associated with the
specified eventName. |
WorkflowTask |
getWorkflowTaskById(String taskId)
Returns the WorkflowTask with the given taskId. |
| Method Detail |
|---|
Workflow getWorkflowByName(String workflowName)
throws RepositoryException
Returns a Workflow with the given workflowName.
workflowName - The name of the Workflow to obtain.
Workflow with the specified name.
RepositoryException - If any error occurs.
Workflow getWorkflowById(String workflowId)
throws RepositoryException
Returns a Workflow with the given workflowId.
workflowId - The ID of the Workflow to obtain.
Workflow with the given ID.
RepositoryException - If any error occurs.
List getWorkflows()
throws RepositoryException
Gets all Workflows from the repository.
List of all Workflows in the repository.
RepositoryException - If any error occurs.
List getTasksByWorkflowId(String workflowId)
throws RepositoryException
Returns a List of WorkflowTasks associated with the
specified Workflow identified by its workflowId.
workflowId - The ID of the Workflow to obtain the List of
WorkflowTasks for.
List of WorkflowTasks associated with the
specified Workflow.
RepositoryException - If any error occurs.
List getTasksByWorkflowName(String workflowName)
throws RepositoryException
Returns a List of WorkflowTasks associated with the
specified Workflow identified by its workflowName.
workflowName - The Name of the Workflow to obtain the List of
WorkflowTasks for.
List of WorkflowTasks associated with the
specified Workflow.
RepositoryException - If any error occurs.
List getWorkflowsForEvent(String eventName)
throws RepositoryException
Returns a List of Workflows associated with the
specified eventName.
eventName - The name of the event to search for workflows for.
List of Workflows associated with the
specified event.
RepositoryException - If any error occurs.
List getConditionsByTaskName(String taskName)
throws RepositoryException
Returns an ordered List of WorkflowConditions associated with the given taskName.
taskName - The taskName to obtain the conditions for.
List of WorkflowConditions associated with the given taskName
RepositoryException - If any error occurs.
List getConditionsByTaskId(String taskId)
throws RepositoryException
Returns an ordered List of WorkflowConditions associated
with the given taskId.
taskId - The ID of the task to obtain the conditions for.
List of WorkflowConditions associated
with the given taskId
RepositoryException - If any error occurs.
WorkflowTaskConfiguration getConfigurationByTaskId(String taskId)
throws RepositoryException
Gets the WorkflowTaskConfiguration metadata for the
WorkflowTask with the given taskId.
taskId - The ID of the WorkflowTask to get the
WorkflowTaskConfiguration metadata for.
WorkflowTaskConfiguration metadata for the
WorkflowTask with the given taskId.
RepositoryException - If any error occurs.
WorkflowTask getWorkflowTaskById(String taskId)
throws RepositoryException
Returns the WorkflowTask with the given taskId.
taskId - The ID of the WorkflowTask to return.
WorkflowTask with the given taskId.
RepositoryException - If any error occurs.
WorkflowCondition getWorkflowConditionById(String conditionId)
throws RepositoryException
Returns the WorkflowCondition with the given conditionId.
conditionId - The ID of the WorkflowCondition to return.
WorkflowCondition with the given conditionId.
RepositoryException - If any error occurs.
List getRegisteredEvents()
throws RepositoryException
Gets a List of Events that are registered in the
Workflow Manager as having valid Workflows mapped to their
names.
List of Events that are registered in
the Workflow Manager as having valid Workflows mapped to
their names.
RepositoryException - If any error occurs.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||