org.apache.lenya.cms.site.usecases
Class EmptyTrash

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.lenya.cms.usecase.AbstractUsecase
          org.apache.lenya.cms.site.usecases.EmptyTrash

All Implemented Interfaces:

org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.lenya.cms.usecase.Usecase

public class EmptyTrash
extends org.apache.lenya.cms.usecase.AbstractUsecase

Empty the trash.

Version:

$Id: EmptyTrash.java 473861 2006-11-12 03:51:14Z gregor $

Field Summary

protected static java.lang.String

DOCUMENTS

Fields inherited from class org.apache.lenya.cms.usecase.AbstractUsecase

ATTRIBUTE_NAME, ATTRIBUTE_POLICY, ATTRIBUTE_USECASE, ATTRIBUTE_VALUE, context, ELEMENT_EXIT, ELEMENT_PARAMETER, ELEMENT_TRANSACTION, ELEMENT_VIEW, ERROR_OBJECTS_CHECKED_OUT, EVENT_CHECK_EXECUTION_CONDITIONS, EVENT_CHECK_POSTCONDITIONS, EVENT_CHECK_PRECONDITIONS, EVENT_EXECUTE, manager, MODEL, PARAMETER_CHECKOUT_RESTRICTED_TO_SESSION, PARAMETER_FACTORY, PARAMETER_SESSION, PARAMETER_STATE_MACHINE, PARAMETERS_INITIALIZED, SOURCE_URL, TRANSITIONS, VALUE_OPTIMISTIC, VALUE_PESSIMISTIC

Fields inherited from interface org.apache.lenya.cms.usecase.Usecase

ROLE

Constructor Summary

EmptyTrash()

Method Summary

protected void	doExecute()
protected org.apache.lenya.cms.repository.Node[]	getNodesToLock() Lock the following objects: all involved documents in the trash area the document trash site structure
protected org.apache.lenya.cms.publication.Document[]	getTrashDocuments()
protected void	initParameters()

Methods inherited from class org.apache.lenya.cms.usecase.AbstractUsecase

addErrorMessage, addErrorMessage, addErrorMessages, addInfoMessage, addInfoMessage, advance, advanceState, cancel, canCheckOut, checkEvent, checkExecutionConditions, checkoutRestrictedToSession, checkPostconditions, checkPreconditions, clearErrorMessages, clearInfoMessages, configure, contextualize, deleteParameter, doCheckExecutionConditions, doCheckPostconditions, doCheckPreconditions, doInitialize, dumpErrorMessages, execute, getBooleanCheckboxParameter, getContext, getDocumentFactory, getErrorMessages, getExitQueryString, getInfoMessages, getName, getParameter, getParameter, getParameterAsBoolean, getParameterAsInteger, getParameterAsString, getParameterAsString, getParameterNames, getParameters, getPart, getSession, getSourceURL, getStateMachine, getTargetURL, getView, hasErrors, hasInfoMessages, initialize, initializeParametersIfNotDone, isOptimistic, lockInvolvedObjects, lockInvolvedObjects, prepareView, service, setDefaultTargetURL, setExitParameter, setName, setParameter, setPart, setSession, setSourceURL, setTestSession, setView, startTransaction

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENTS

protected static final java.lang.String DOCUMENTS

See Also:

Constant Field Values

Constructor Detail

EmptyTrash

public EmptyTrash()

Method Detail

initParameters

protected void initParameters()

Overrides:

initParameters in class org.apache.lenya.cms.usecase.AbstractUsecase

See Also:

AbstractUsecase.initParameters()

getNodesToLock

protected org.apache.lenya.cms.repository.Node[] getNodesToLock()
                                                         throws org.apache.lenya.cms.usecase.UsecaseException

Lock the following objects:

• all involved documents in the trash area
• the document trash site structure

Overrides:

getNodesToLock in class org.apache.lenya.cms.usecase.AbstractUsecase

Throws:

org.apache.lenya.cms.usecase.UsecaseException

See Also:

AbstractUsecase.getNodesToLock()

doExecute

protected void doExecute()
                  throws java.lang.Exception

Overrides:

doExecute in class org.apache.lenya.cms.usecase.AbstractUsecase

Throws:

java.lang.Exception

See Also:

AbstractUsecase.doExecute()

getTrashDocuments

protected org.apache.lenya.cms.publication.Document[] getTrashDocuments()
                                                                 throws org.apache.lenya.cms.publication.PublicationException,
                                                                        org.apache.lenya.cms.site.SiteException

Returns:

The documents in the trash area.

Throws:

org.apache.lenya.cms.publication.PublicationException - if an error occurs.

org.apache.lenya.cms.site.SiteException - if an error occurs.