org.apache.lenya.cms.workflow.usecases
Class UsecaseWorkflowHelper

java.lang.Object
  extended by org.apache.lenya.cms.workflow.usecases.UsecaseWorkflowHelper

public class UsecaseWorkflowHelper
extends java.lang.Object

Helper class for workflow related usecases.


Field Summary
protected static java.lang.String ERROR_CANNOT_INVOKE_EVENT
          The error message that an event can not be invoked on a document.
 
Constructor Summary
UsecaseWorkflowHelper()
           
 
Method Summary
protected static void addWorkflowError(org.apache.lenya.cms.usecase.AbstractUsecase usecase, java.lang.String event, org.apache.lenya.cms.publication.Document doc)
          Adds an error message to a usecase that an event cannot be invoked on a document.
static void checkWorkflow(org.apache.avalon.framework.service.ServiceManager manager, org.apache.lenya.cms.usecase.AbstractUsecase usecase, java.lang.String event, org.apache.lenya.cms.publication.Document doc, org.apache.avalon.framework.logger.Logger logger)
          Adds an error message if the event can not be invoked.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ERROR_CANNOT_INVOKE_EVENT

protected static final java.lang.String ERROR_CANNOT_INVOKE_EVENT
The error message that an event can not be invoked on a document. It takes two parameters: the event name and the document title.

See Also:
Constant Field Values
Constructor Detail

UsecaseWorkflowHelper

public UsecaseWorkflowHelper()
Method Detail

addWorkflowError

protected static final void addWorkflowError(org.apache.lenya.cms.usecase.AbstractUsecase usecase,
                                             java.lang.String event,
                                             org.apache.lenya.cms.publication.Document doc)
Adds an error message to a usecase that an event cannot be invoked on a document.

Parameters:
usecase - The usecase.
event - The event.
doc - The document.

checkWorkflow

public static final void checkWorkflow(org.apache.avalon.framework.service.ServiceManager manager,
                                       org.apache.lenya.cms.usecase.AbstractUsecase usecase,
                                       java.lang.String event,
                                       org.apache.lenya.cms.publication.Document doc,
                                       org.apache.avalon.framework.logger.Logger logger)
Adds an error message if the event can not be invoked.

Parameters:
manager - The service manager.
usecase - The usecase.
event - The event.
doc - The document.
logger - The logger.


Copyright $ Apache Software Foundation. All Rights Reserved.