org.apache.lenya.cms.task
Interface TaskWrapper

All Known Implementing Classes:

CocoonTaskWrapper, DefaultTaskWrapper

public interface TaskWrapper

A TaskWrapper encapsulates all information that is needed to execute a certain task, including e.g. workflow and notification parameters.

Method Summary

void	execute() Executes the task.
java.util.Map	getParameters() Returns the task wrapper parameters.
void	restore(NamespaceHelper helper, org.w3c.dom.Element element)
org.w3c.dom.Element	save(NamespaceHelper helper) Saves the wrapper parameters to an XML element.

Method Detail

execute

void execute()
             throws ExecutionException

Executes the task.

Throws:

ExecutionException - when something went wrong.

save

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

Saves the wrapper parameters to an XML element.

Parameters:

helper - The namespace helper of the document.

Returns:

An XML element.

restore

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

Parameters:

helper - The namespace helper of the document. Restores the wrapper parameters from an XML element.

element - An XML element.

getParameters

java.util.Map getParameters()

Returns the task wrapper parameters.

Returns:

A map.