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

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.lenya.cms.workflow.usecases.WorkflowableWrapper

All Implemented Interfaces:

org.apache.avalon.framework.logger.LogEnabled

public class WorkflowableWrapper
extends org.apache.avalon.framework.logger.AbstractLogEnabled

Wrap a workflowable for easy evaluation in JX template.

Constructor Summary

WorkflowableWrapper(MultiWorkflow usecase, org.apache.avalon.framework.service.ServiceManager manager, org.apache.lenya.cms.repository.Session session, org.apache.lenya.cms.publication.Document document, org.apache.avalon.framework.logger.Logger logger)
Ctor.

Method Summary

java.lang.String	getLanguage()
java.lang.String[]	getLanguages()
java.lang.String	getPath()
java.lang.String	getState()
java.lang.String[]	getStates()
java.lang.String	getUrl()
java.lang.String[]	getUsecases()
protected org.apache.lenya.workflow.Workflowable	getWorkflowable()
protected org.apache.lenya.workflow.Workflow	getWorkflowSchema()

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

WorkflowableWrapper

public WorkflowableWrapper(MultiWorkflow usecase,
                           org.apache.avalon.framework.service.ServiceManager manager,
                           org.apache.lenya.cms.repository.Session session,
                           org.apache.lenya.cms.publication.Document document,
                           org.apache.avalon.framework.logger.Logger logger)

Ctor.

Parameters:

usecase - The usecase.

manager - The service manager.

session - The session.

document - The document to wrap.

logger - The logger.

Method Detail

getWorkflowable

protected org.apache.lenya.workflow.Workflowable getWorkflowable()

getState

public java.lang.String getState()
                          throws org.apache.lenya.workflow.WorkflowException

Returns:

The state of the latest version.

Throws:

org.apache.lenya.workflow.WorkflowException

getStates

public java.lang.String[] getStates()
                             throws org.apache.lenya.workflow.WorkflowException

Returns:

All states supported by the workflow schema.

Throws:

org.apache.lenya.workflow.WorkflowException

getWorkflowSchema

protected org.apache.lenya.workflow.Workflow getWorkflowSchema()
                                                        throws org.apache.lenya.workflow.WorkflowException

Throws:

org.apache.lenya.workflow.WorkflowException

getPath

public java.lang.String getPath()
                         throws org.apache.lenya.cms.publication.DocumentException

Returns:

The path of the document.

Throws:

org.apache.lenya.cms.publication.DocumentException - If the document is not referenced in the site structure.

getLanguage

public java.lang.String getLanguage()

Returns:

The language of the document.

getUrl

public java.lang.String getUrl()

Returns:

The web application URL of the document.

getUsecases

public java.lang.String[] getUsecases()
                               throws org.apache.lenya.workflow.WorkflowException

Returns:

All executable events in alphabetical order.

Throws:

org.apache.lenya.workflow.WorkflowException - if an error occurs.

getLanguages

public java.lang.String[] getLanguages()
                                throws org.apache.lenya.cms.publication.DocumentException

Returns:

The languages of the document in alphabetical order.

Throws:

org.apache.lenya.cms.publication.DocumentException