org.apache.fulcrum.osworkflow
Class DefaultWorkflowService

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.fulcrum.osworkflow.DefaultWorkflowService

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.thread.ThreadSafe, WorkflowService

public class DefaultWorkflowService

extends org.apache.avalon.framework.logger.AbstractLogEnabled

implements WorkflowService, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.thread.ThreadSafe

This service provides a simple interface to the OSWorkflow Engine. You can also directly access the OSWorkflow engine.

Version:

$Id: DefaultWorkflowService.java 535465 2007-05-05 06:58:06Z tv $

Author:

Eric Pugh

Field Summary

Fields inherited from interface org.apache.fulcrum.osworkflow.WorkflowService

ROLE

Constructor Summary

DefaultWorkflowService()

Method Summary

void	configure(org.apache.avalon.framework.configuration.Configuration conf) Avalon component configure lifecycle method
void	dispose() Avalon component disposelifecycle method
void	initialize() Avalon component initialize lifecycle method
Workflow	retrieveWorkflow(java.lang.String caller) Retrives a workflow based on the caller
long[]	retrieveWorkflows(java.lang.String caller, java.lang.String status) For a specific caller and status, return all the workflows.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWorkflowService

public DefaultWorkflowService()

Method Detail

retrieveWorkflows

public long[] retrieveWorkflows(java.lang.String caller,
                                java.lang.String status)
                         throws WorkflowException

For a specific caller and status, return all the workflows.

Specified by:

retrieveWorkflows in interface WorkflowService

Parameters:

caller - The name of the caller.

status - The status of the workflows to retreive. Definied by the workflow.xml file

Returns:

An array of long's for the workflow ID's.

Throws:

WorkflowException - if there is a problem

retrieveWorkflow

public Workflow retrieveWorkflow(java.lang.String caller)

Retrives a workflow based on the caller

Specified by:

retrieveWorkflow in interface WorkflowService

Parameters:

caller - The workflow for this caller.

Returns:

the Workflow for this caller

configure

public void configure(org.apache.avalon.framework.configuration.Configuration conf)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Avalon component configure lifecycle method

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

initialize

public void initialize()
                throws java.lang.Exception

Avalon component initialize lifecycle method

Specified by:

initialize in interface org.apache.avalon.framework.activity.Initializable

Throws:

java.lang.Exception

dispose

public void dispose()

Avalon component disposelifecycle method

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable