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

org.apache.lenya.defaultpub.cms.task
Class Deactivate

java.lang.Object
  org.apache.lenya.cms.task.AbstractTask
      org.apache.lenya.cms.publication.task.PublicationTask
          org.apache.lenya.defaultpub.cms.task.Deactivate

All Implemented Interfaces:

org.apache.avalon.framework.parameters.Parameterizable, Task

public class Deactivate
extends PublicationTask

Deactivate a document.

Field Summary

static java.lang.String	PARAMETER_DOCUMENT_ID
static java.lang.String	PARAMETER_DOCUMENT_LANGUAGE

Fields inherited from class org.apache.lenya.cms.publication.task.PublicationTask

PARAMETER_IP_ADDRESS, PARAMETER_ROLE_IDS, PARAMETER_USER_ID, PARAMETER_WORKFLOW_EVENT, ROLE_SEPARATOR_REGEXP

Fields inherited from interface org.apache.lenya.cms.task.Task

DEFAULT_PREFIX, FAILURE, NAMESPACE, PARAMETER_CONTEXT_PREFIX, PARAMETER_PUBLICATION_ID, PARAMETER_SERVER_PORT, PARAMETER_SERVER_URI, PARAMETER_SERVLET_CONTEXT, SUCCESS

Constructor Summary

Deactivate()

Method Summary

protected boolean	checkPreconditions(Document liveDocument) Checks if the preconditions are complied.
protected void	deactivate(Document liveDocument) Deactivates a document.
void	execute(java.lang.String servletContextPath) Execute the task.
protected Document	getLiveDocument() Returns the live document to apply this task on.

Methods inherited from class org.apache.lenya.cms.publication.task.PublicationTask

canCheckOut, canWorkflowFire, copyResources, getEventName, getExecutableEvent, getPublication, getRevisionController, getRevisionFilePath, getRoleIDs, getSituation, reservedCheckIn, reservedCheckOut, triggerWorkflow

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

getParameters, getResult, parameterize, setLabel, setResult

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_DOCUMENT_ID

public static final java.lang.String PARAMETER_DOCUMENT_ID

See Also:

Constant Field Values

PARAMETER_DOCUMENT_LANGUAGE

public static final java.lang.String PARAMETER_DOCUMENT_LANGUAGE

See Also:

Constant Field Values

Constructor Detail

Deactivate

public Deactivate()

Method Detail

execute

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

Description copied from interface: Task

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

Parameters:

servletContextPath - the servlet-context

Throws:

ExecutionException - if the execution fails

See Also:

Task.execute(java.lang.String)

checkPreconditions

protected boolean checkPreconditions(Document liveDocument)
                              throws PublicationException,
                                     DocumentException,
                                     SiteTreeException,
                                     ExecutionException

Checks if the preconditions are complied.

Parameters:

liveDocument - The document to publish.

Returns:

A boolean value.

Throws:

PublicationException - when something went wrong.

ExecutionException - when something went wrong.

DocumentException - when something went wrong. FIXME: Remove references to sitetree

SiteTreeException

deactivate

protected void deactivate(Document liveDocument)
                   throws PublicationException,
                          ExecutionException,
                          java.io.IOException,
                          org.apache.avalon.framework.parameters.ParameterException,
                          WorkflowException,
                          DocumentException

Deactivates a document.

Parameters:

liveDocument - The live document.

Throws:

PublicationException

ExecutionException

java.io.IOException

org.apache.avalon.framework.parameters.ParameterException

WorkflowException

DocumentException

getLiveDocument

protected Document getLiveDocument()
                            throws org.apache.avalon.framework.parameters.ParameterException,
                                   DocumentBuildException,
                                   ExecutionException

Returns the live document to apply this task on.

Returns:

A document.

Throws:

org.apache.avalon.framework.parameters.ParameterException - when something went wrong.

DocumentBuildException - when something went wrong.

ExecutionException - when something went wrong.