Task

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> lenya >> cms >> [ task overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.lenya.cms.task.Task

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.lenya.cms.task
Interface Task

All Known Implementing Classes:: AbstractTask

public interface Task

A Task is a command that can be executed.
When a Task is executed from a TaskAction or initialized from a TaskJob, the default parameters are provided. This is not a contract!

Field Summary

static java.lang.String DEFAULT_PREFIX


static int FAILURE


static java.lang.String NAMESPACE


static java.lang.String PARAMETER_CONTEXT_PREFIX
          The part of the URI that precedes the publication ID:
http://www.yourhost.com:8080/lenya/publication/index.html

static java.lang.String PARAMETER_PUBLICATION_ID
          The publication ID:
http://www.yourhost.com:8080/lenya/publication/index.html

static java.lang.String PARAMETER_SERVER_PORT
          The server port:
http://www.yourhost.com:8080/lenya/publication/index.html

static java.lang.String PARAMETER_SERVER_URI
          The server URI:
http://www.yourhost.com:8080/lenya/publication/index.html

static java.lang.String PARAMETER_SERVLET_CONTEXT
          The path of the servlet context:
/home/user_id/build/jakarta-tomcat/webapps/lenyacms

static int SUCCESS


Method Summary

void execute(java.lang.String servletContextPath)
          Execute the task.

int getResult()
          Returns the result of the task (SUCCESS 55 , FAILURE).

void setLabel(java.lang.String label)
          Set the label that is used to identify the task.

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:: Constant Field Values

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX

See Also:: Constant Field Values

SUCCESS

public static final int SUCCESS

See Also:: Constant Field Values

FAILURE

public static final int FAILURE

See Also:: Constant Field Values

PARAMETER_SERVLET_CONTEXT

public static final java.lang.String PARAMETER_SERVLET_CONTEXT

The path of the servlet context:
/home/user_id/build/jakarta-tomcat/webapps/lenyacms

See Also:: Constant Field Values

PARAMETER_SERVER_URI

public static final java.lang.String PARAMETER_SERVER_URI

The server URI:
http://www.yourhost.com:8080/lenya/publication/index.html

See Also:: Constant Field Values

PARAMETER_SERVER_PORT

public static final java.lang.String PARAMETER_SERVER_PORT

The server port:
http://www.yourhost.com:8080/lenya/publication/index.html

See Also:: Constant Field Values

PARAMETER_CONTEXT_PREFIX

public static final java.lang.String PARAMETER_CONTEXT_PREFIX

The part of the URI that precedes the publication ID:
http://www.yourhost.com:8080/lenya/publication/index.html

See Also:: Constant Field Values

PARAMETER_PUBLICATION_ID

public static final java.lang.String PARAMETER_PUBLICATION_ID

The publication ID:
http://www.yourhost.com:8080/lenya/publication/index.html

See Also:: Constant Field Values

Method Detail

execute

public void execute(java.lang.String servletContextPath)
             throws ExecutionException

Execute the task. All parameters must have been set with parameterize().

setLabel

public void setLabel(java.lang.String label)

Set the label that is used to identify the task.

getResult

public int getResult()

Returns the result of the task (SUCCESS 55 , FAILURE).