This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.task
Class TaskParameters

java.lang.Object
  org.apache.lenya.cms.task.ParameterWrapper
      org.apache.lenya.cms.task.TaskParameters

public class TaskParameters
extends ParameterWrapper

Field Summary

static java.lang.String	PREFIX
static java.lang.String[]	REQUIRED_KEYS

Constructor Summary

TaskParameters(java.util.Map prefixedParameters)
Ctor.

Method Summary

java.lang.String	getPrefix() Returns the namespace prefix.
Publication	getPublication() Returns the publication.
protected java.lang.String[]	getRequiredKeys() Returns the required keys.
void	setPublication(Publication publication) Sets the publication.
void	setServletContextPath(java.lang.String servletContextPath) Sets the servlet context path.

Methods inherited from class org.apache.lenya.cms.task.ParameterWrapper

get, getMap, getMissingKeys, isComplete, parameterize, put

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_KEYS

public static final java.lang.String[] REQUIRED_KEYS

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

Constructor Detail

TaskParameters

public TaskParameters(java.util.Map prefixedParameters)

Ctor.

Parameters:

prefixedParameters - The prefixed parameters .

Method Detail

getPrefix

public java.lang.String getPrefix()

Description copied from class: ParameterWrapper

Returns the namespace prefix.

Specified by:

getPrefix in class ParameterWrapper

Returns:

A string.

See Also:

ParameterWrapper.getPrefix()

getRequiredKeys

protected java.lang.String[] getRequiredKeys()

Description copied from class: ParameterWrapper

Returns the required keys.

Specified by:

getRequiredKeys in class ParameterWrapper

Returns:

A string array.

See Also:

ParameterWrapper.getRequiredKeys()

getPublication

public Publication getPublication()
                           throws ExecutionException

Returns the publication.

Returns:

A publication.

Throws:

ExecutionException - when something went wrong.

setPublication

public void setPublication(Publication publication)

Sets the publication.

Parameters:

publication - A publication.

setServletContextPath

public void setServletContextPath(java.lang.String servletContextPath)

Sets the servlet context path.

Parameters:

servletContextPath - A string.