org.apache.lenya.cms.task
Class DefaultTaskWrapper

java.lang.Object
  org.apache.lenya.cms.task.DefaultTaskWrapper

All Implemented Interfaces:

TaskWrapper

Direct Known Subclasses:

CocoonTaskWrapper

public class DefaultTaskWrapper
extends java.lang.Object
implements TaskWrapper

Field Summary

protected static java.lang.String	ATTRIBUTE_NAME
protected static java.lang.String	ATTRIBUTE_VALUE
protected static java.lang.String	ELEMENT_PARAMETER
protected static java.lang.String	ELEMENT_TASK

Constructor Summary

protected	DefaultTaskWrapper() Default ctor for subclasses.
	DefaultTaskWrapper(java.util.Map parameters) Ctor to be called when all task wrapper parameters are known.
	DefaultTaskWrapper(NamespaceHelper helper, org.w3c.dom.Element parent) Ctor.

Method Summary

void	execute() Executes the task.
protected org.apache.avalon.framework.parameters.Parameters	extractTaskParameters(org.apache.avalon.framework.parameters.Parameters parameters, Publication publication, org.apache.cocoon.environment.Request request) Extracts the task parameters from the given objects.
protected java.util.Map	getParameterObject() Returns all prefixed parameters.
java.util.Map	getParameters() Returns all prefixed parameters.
TaskParameters	getTaskParameters() Returns the task parameters.
TaskWrapperParameters	getWrapperParameters() Returns the task wrapper parameters.
protected void	initialize(java.lang.String taskId, Publication publication, java.lang.String webappUrl, org.apache.avalon.framework.parameters.Parameters parameters) Initializes the task wrapper.
void	restore(NamespaceHelper helper, org.w3c.dom.Element parent) Restores the wrapper parameters from an XML element.
org.w3c.dom.Element	save(NamespaceHelper helper) Saves the wrapper parameters to an XML element.
protected void	setNotifying(NamespaceMap notificationParameters) Sets the notification parameters.
void	setWorkflowAware(java.lang.String eventName, Identity identity, Role[] roles) Enables workflow transition invocation.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_TASK

protected static final java.lang.String ELEMENT_TASK

See Also:

Constant Field Values

ELEMENT_PARAMETER

protected static final java.lang.String ELEMENT_PARAMETER

See Also:

Constant Field Values

ATTRIBUTE_NAME

protected static final java.lang.String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_VALUE

protected static final java.lang.String ATTRIBUTE_VALUE

See Also:

Constant Field Values

Constructor Detail

DefaultTaskWrapper

protected DefaultTaskWrapper()

Default ctor for subclasses.

DefaultTaskWrapper

public DefaultTaskWrapper(java.util.Map parameters)

Ctor to be called when all task wrapper parameters are known. All keys and values must be strings or string arrays.

Parameters:

parameters - The prefixed parameters.

DefaultTaskWrapper

public DefaultTaskWrapper(NamespaceHelper helper,
                          org.w3c.dom.Element parent)

Ctor. Restores the wrapper parameters from an XML element.

Parameters:

parent - The parent of the task wrapper element.

helper - The namespace helper of the document.

Method Detail

initialize

protected void initialize(java.lang.String taskId,
                          Publication publication,
                          java.lang.String webappUrl,
                          org.apache.avalon.framework.parameters.Parameters parameters)
                   throws ExecutionException

Initializes the task wrapper.

Parameters:

taskId - The task ID.

publication - The publication.

webappUrl - The webapp URL.

parameters - The task parameters.

Throws:

ExecutionException - when the task ID is null.

extractTaskParameters

protected org.apache.avalon.framework.parameters.Parameters extractTaskParameters(org.apache.avalon.framework.parameters.Parameters parameters,
                                                                                  Publication publication,
                                                                                  org.apache.cocoon.environment.Request request)

Extracts the task parameters from the given objects.

Parameters:

parameters - A parameters object.

publication - A publication.

request - A request.

Returns:

A parameters object.

setWorkflowAware

public void setWorkflowAware(java.lang.String eventName,
                             Identity identity,
                             Role[] roles)

Enables workflow transition invocation.

Parameters:

eventName - The event name.

identity - The identity that executes the task.

roles - The roles of the identity.

execute

public void execute()
             throws ExecutionException

Executes the task.

Specified by:

execute in interface TaskWrapper

Throws:

ExecutionException - when something went wrong.

getWrapperParameters

public TaskWrapperParameters getWrapperParameters()

Returns the task wrapper parameters.

Returns:

A task wrapper parameters object.

getTaskParameters

public TaskParameters getTaskParameters()

Returns the task parameters.

Returns:

A task parameters object.

save

public org.w3c.dom.Element save(NamespaceHelper helper)

Saves the wrapper parameters to an XML element.

Specified by:

save in interface TaskWrapper

Parameters:

helper - The namespace helper of the document.

Returns:

An XML element.

restore

public void restore(NamespaceHelper helper,
                    org.w3c.dom.Element parent)

Restores the wrapper parameters from an XML element.

Specified by:

restore in interface TaskWrapper

Parameters:

parent - The parent of the task wrapper element.

helper - The namespace helper of the document.

getParameters

public java.util.Map getParameters()

Returns all prefixed parameters.

Specified by:

getParameters in interface TaskWrapper

Returns:

A map.

getParameterObject

protected java.util.Map getParameterObject()

Returns all prefixed parameters.

Returns:

A map.

setNotifying

protected void setNotifying(NamespaceMap notificationParameters)

Sets the notification parameters.

Parameters:

notificationParameters - The notification parameters.