org.infoglue.cms.applications.workflowtool.function
Class ContentFunction

java.lang.Object
  org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase
      org.infoglue.cms.applications.workflowtool.function.InfoglueFunction
          org.infoglue.cms.applications.workflowtool.function.ContentFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

Direct Known Subclasses:

Attach, AttachmentsProvider, ContentCleaner, ContentCreator, ContentMover, ContentPropertysetPopulator, ContentPublisher

public abstract class ContentFunction
extends InfoglueFunction

Base class for all functions operating on ContentVO objects.

Field Summary

static java.lang.String	CONTENT_PARAMETER
static java.lang.String	CONTENT_VERSION_PARAMETER

Fields inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

LOCALE_PARAMETER, PRINCIPAL_PARAMETER

Fields inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

ERROR_PROPERTYSET_PREFIX, FUNCTION_STATUS_PROPERTYSET_KEY, UTF8_ENCODING, WORKFLOW_PROPERTYSET_PREFIX

Constructor Summary

protected

ContentFunction() Default constructor.

Method Summary

protected java.lang.String	getAttribute(java.lang.String name, boolean escapeHTML)
protected Content	getContent()
protected ContentVersion	getContentVersion()
protected ContentVersionVO	getContentVersionVO()
protected ContentVO	getContentVO()
protected void	initialize() Method used for initializing the function; will be called before execute is called.

Methods inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

execute, execute, getLocale, getPrincipal, getRequestParameter, setFunctionStatus

Methods inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

argumentExists, getArgument, getArgument, getDatabase, getLogger, getParameter, getParameter, getParameter, getParameters, getPropertySet, getPropertySetDataString, getPropertySetString, getVariableFromMaps, parameterExists, propertySetContains, removeFromPropertySet, removeFromPropertySet, setParameter, setPropertySetDataString, setPropertySetString, storeContext, throwException, throwException, translate, translateVariables

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_PARAMETER

public static final java.lang.String CONTENT_PARAMETER

See Also:

Constant Field Values

CONTENT_VERSION_PARAMETER

public static final java.lang.String CONTENT_VERSION_PARAMETER

See Also:

Constant Field Values

Constructor Detail

ContentFunction

protected ContentFunction()

Default constructor.

Method Detail

getContentVO

protected ContentVO getContentVO()

getContentVersionVO

protected ContentVersionVO getContentVersionVO()

getContent

protected Content getContent()

getContentVersion

protected ContentVersion getContentVersion()

getAttribute

protected java.lang.String getAttribute(java.lang.String name,
                                        boolean escapeHTML)
                                 throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

initialize

protected void initialize()
                   throws com.opensymphony.workflow.WorkflowException

Method used for initializing the function; will be called before execute is called.

Note! You must call super.initialize() first.

Overrides:

initialize in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the initialization.