org.apache.oodt.cas.workflow.instrepo
Interface WorkflowInstanceRepository

All Superinterfaces:
Pagination
All Known Implementing Classes:
AbstractPaginatibleInstanceRepository, DataSourceWorkflowInstanceRepository, LuceneWorkflowInstanceRepository, MemoryWorkflowInstanceRepository

public interface WorkflowInstanceRepository
extends Pagination

Version:
$Revision$

Describe your class here

.
Author:
mattmann

Field Summary
static String X_POINT_ID
           
 
Method Summary
 void addWorkflowInstance(WorkflowInstance wInst)
          Persists the specified WorkflowInstance to the instance repository.
 int getNumWorkflowInstances()
          Gets the number of WorkflowInstances with any status being managed by this WorkflowInstanceRepository.
 int getNumWorkflowInstancesByStatus(String status)
          Gets the number of WorkflowInstances with the given status being managed by this WorkflowInstanceRepository.
 WorkflowInstance getWorkflowInstanceById(String workflowInstId)
           Returns the WorkflowInstances with the specified workflowInstId.
 List getWorkflowInstances()
           
 List getWorkflowInstancesByStatus(String status)
           Returns a List of WorkflowInstances, with the specified status String.
 void removeWorkflowInstance(WorkflowInstance wInst)
          Removes the specified WorkflowInstance from the instance repository.
 void updateWorkflowInstance(WorkflowInstance wInst)
          Updates and persists the specified WorkflowInstance to the instance repository.
 
Methods inherited from interface org.apache.oodt.cas.workflow.util.Pagination
getFirstPage, getLastPage, getNextPage, getPagedWorkflows, getPagedWorkflows, getPrevPage
 

Field Detail

X_POINT_ID

static final String X_POINT_ID
Method Detail

addWorkflowInstance

void addWorkflowInstance(WorkflowInstance wInst)
                         throws InstanceRepositoryException
Persists the specified WorkflowInstance to the instance repository.

Parameters:
wInst - The workflow instance to persist.
Throws:
InstanceRepositoryException - If any error occurs.

updateWorkflowInstance

void updateWorkflowInstance(WorkflowInstance wInst)
                            throws InstanceRepositoryException
Updates and persists the specified WorkflowInstance to the instance repository.

Parameters:
wInst - The workflow instance to update and persist.
Throws:
InstanceRepositoryException - If any error occurs.

removeWorkflowInstance

void removeWorkflowInstance(WorkflowInstance wInst)
                            throws InstanceRepositoryException
Removes the specified WorkflowInstance from the instance repository.

Parameters:
wInst - The workflow instance to remove.
Throws:
InstanceRepositoryException - If any error occurs.

getWorkflowInstanceById

WorkflowInstance getWorkflowInstanceById(String workflowInstId)
                                         throws InstanceRepositoryException

Returns the WorkflowInstances with the specified workflowInstId.

Parameters:
workflowInstId - The ID of the WorkflowInstance to return.
Returns:
The specified WorkflowInstance.
Throws:
InstanceRepositoryException - If any error occurs.

getWorkflowInstances

List getWorkflowInstances()
                          throws InstanceRepositoryException
Returns:
A List of WorkflowInstances that this WorkflowEngine is managing.
Throws:
InstanceRepositoryException - If any error occurs.

getWorkflowInstancesByStatus

List getWorkflowInstancesByStatus(String status)
                                  throws InstanceRepositoryException

Returns a List of WorkflowInstances, with the specified status String.

Parameters:
status - A string representation of the status of the WorkflowInstance.
Returns:
A List of WorkflowInstances, with the specified status String.
Throws:
InstanceRepositoryException - If there is any error that occurs.

getNumWorkflowInstances

int getNumWorkflowInstances()
                            throws InstanceRepositoryException
Gets the number of WorkflowInstances with any status being managed by this WorkflowInstanceRepository.

Returns:
The number of WorkflowInstances associated with any status being managed by this WorkflowInstanceRepository.
Throws:
InstanceRepositoryException

getNumWorkflowInstancesByStatus

int getNumWorkflowInstancesByStatus(String status)
                                    throws InstanceRepositoryException
Gets the number of WorkflowInstances with the given status being managed by this WorkflowInstanceRepository.

Parameters:
status - The status to obtain the number of WorkflowInstances for.
Returns:
The number of WorkflowInstances with the given status.
Throws:
InstanceRepositoryException - If there is any error that occurs.


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