org.apache.oodt.cas.workflow.repository
Interface WorkflowRepository

All Known Implementing Classes:
DataSourceWorkflowRepository, XMLWorkflowRepository

public interface WorkflowRepository

Version:
$Revision$

A repository interface for obtaining Workflows, and managing the information about their WorkflowTasks.

Author:
mattmann

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

getWorkflowByName

Workflow getWorkflowByName(String workflowName)
                           throws RepositoryException

Returns a Workflow with the given workflowName.

Parameters:
workflowName - The name of the Workflow to obtain.
Returns:
A Workflow with the specified name.
Throws:
RepositoryException - If any error occurs.

getWorkflowById

Workflow getWorkflowById(String workflowId)
                         throws RepositoryException

Returns a Workflow with the given workflowId.

Parameters:
workflowId - The ID of the Workflow to obtain.
Returns:
A Workflow with the given ID.
Throws:
RepositoryException - If any error occurs.

getWorkflows

List getWorkflows()
                  throws RepositoryException

Gets all Workflows from the repository.

Returns:
A List of all Workflows in the repository.
Throws:
RepositoryException - If any error occurs.

getTasksByWorkflowId

List getTasksByWorkflowId(String workflowId)
                          throws RepositoryException

Returns a List of WorkflowTasks associated with the specified Workflow identified by its workflowId.

Parameters:
workflowId - The ID of the Workflow to obtain the List of WorkflowTasks for.
Returns:
A List of WorkflowTasks associated with the specified Workflow.
Throws:
RepositoryException - If any error occurs.

getTasksByWorkflowName

List getTasksByWorkflowName(String workflowName)
                            throws RepositoryException

Returns a List of WorkflowTasks associated with the specified Workflow identified by its workflowName.

Parameters:
workflowName - The Name of the Workflow to obtain the List of WorkflowTasks for.
Returns:
A List of WorkflowTasks associated with the specified Workflow.
Throws:
RepositoryException - If any error occurs.

getWorkflowsForEvent

List getWorkflowsForEvent(String eventName)
                          throws RepositoryException

Returns a List of Workflows associated with the specified eventName.

Parameters:
eventName - The name of the event to search for workflows for.

Returns:
A List of Workflows associated with the specified event.
Throws:
RepositoryException - If any error occurs.

getConditionsByTaskName

List getConditionsByTaskName(String taskName)
                             throws RepositoryException

Returns an ordered List of WorkflowConditions associated with the given taskName.

Parameters:
taskName - The taskName to obtain the conditions for.
Returns:
Returns a List of WorkflowConditions associated with the given taskName
Throws:
RepositoryException - If any error occurs.

getConditionsByTaskId

List getConditionsByTaskId(String taskId)
                           throws RepositoryException

Returns an ordered List of WorkflowConditions associated with the given taskId.

Parameters:
taskId - The ID of the task to obtain the conditions for.
Returns:
Returns a List of WorkflowConditions associated with the given taskId
Throws:
RepositoryException - If any error occurs.

getConfigurationByTaskId

WorkflowTaskConfiguration getConfigurationByTaskId(String taskId)
                                                   throws RepositoryException

Gets the WorkflowTaskConfiguration metadata for the WorkflowTask with the given taskId.

Parameters:
taskId - The ID of the WorkflowTask to get the WorkflowTaskConfiguration metadata for.
Returns:
The WorkflowTaskConfiguration metadata for the WorkflowTask with the given taskId.
Throws:
RepositoryException - If any error occurs.

getWorkflowTaskById

WorkflowTask getWorkflowTaskById(String taskId)
                                 throws RepositoryException

Returns the WorkflowTask with the given taskId.

Parameters:
taskId - The ID of the WorkflowTask to return.
Returns:
the WorkflowTask with the given taskId.
Throws:
RepositoryException - If any error occurs.

getWorkflowConditionById

WorkflowCondition getWorkflowConditionById(String conditionId)
                                           throws RepositoryException

Returns the WorkflowCondition with the given conditionId.

Parameters:
conditionId - The ID of the WorkflowCondition to return.
Returns:
the WorkflowCondition with the given conditionId.
Throws:
RepositoryException - If any error occurs.

getRegisteredEvents

List getRegisteredEvents()
                         throws RepositoryException

Gets a List of Events that are registered in the Workflow Manager as having valid Workflows mapped to their names.

Returns:
a List of Events that are registered in the Workflow Manager as having valid Workflows mapped to their names.
Throws:
RepositoryException - If any error occurs.


Copyright © 1999-2011 Apache OODT. All Rights Reserved.