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

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

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

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 SiteOverview
extends org.apache.lenya.cms.usecase.AbstractUsecase

Overview over all documents.

Nested Class Summary

static class	SiteOverview.Entry Stores document-related information.
static class	SiteOverview.EntryComparator Comparator for entries.

Field Summary

protected static java.lang.String	ALL_DOCUMENTS
protected static java.lang.String	ASC
protected static java.lang.String	DESC
protected static java.lang.String	DOCUMENTS
protected static java.lang.String	FILTER_LANGUAGE
protected static java.lang.String	FILTER_RESOURCE_TYPE
protected static java.lang.String	FILTER_RESOURCE_TYPE_VALUES
protected static java.lang.String	FILTER_WORKFLOW_STATE
protected static java.lang.String	FILTER_WORKFLOW_STATE_VALUES
protected static java.lang.String[]	FILTERS
protected static java.lang.String	KEY_CHECKED_OUT
protected static java.lang.String	KEY_LANGUAGE
protected static java.lang.String	KEY_LAST_MODIFIED
protected static java.lang.String	KEY_PATH
protected static java.lang.String	KEY_RESOURCE_TYPE
protected static java.lang.String	KEY_URL
protected static java.lang.String	KEY_WORKFLOW_STATE
protected static java.lang.String[]	KEYS
protected static java.lang.String	ORDER
protected static java.lang.String	PARAMETER_FILTERS
protected static java.lang.String	PARAMETER_KEYS
protected static java.lang.String	SORT
protected static java.lang.String	VALUE_ALL

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

SiteOverview()

Method Summary

void	advance()
protected org.apache.lenya.cms.publication.Document[]	getDocuments()
protected org.apache.lenya.cms.publication.Publication	getPublication()
protected void	initParameters()

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

addErrorMessage, addErrorMessage, addErrorMessages, addInfoMessage, addInfoMessage, advanceState, cancel, canCheckOut, checkEvent, checkExecutionConditions, checkoutRestrictedToSession, checkPostconditions, checkPreconditions, clearErrorMessages, clearInfoMessages, configure, contextualize, deleteParameter, doCheckExecutionConditions, doCheckPostconditions, doCheckPreconditions, doExecute, doInitialize, dumpErrorMessages, execute, getBooleanCheckboxParameter, getContext, getDocumentFactory, getErrorMessages, getExitQueryString, getInfoMessages, getName, getNodesToLock, 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

ALL_DOCUMENTS

protected static final java.lang.String ALL_DOCUMENTS

See Also:

Constant Field Values

DOCUMENTS

protected static final java.lang.String DOCUMENTS

See Also:

Constant Field Values

FILTER_WORKFLOW_STATE_VALUES

protected static final java.lang.String FILTER_WORKFLOW_STATE_VALUES

See Also:

Constant Field Values

FILTER_RESOURCE_TYPE_VALUES

protected static final java.lang.String FILTER_RESOURCE_TYPE_VALUES

See Also:

Constant Field Values

KEY_PATH

protected static final java.lang.String KEY_PATH

See Also:

Constant Field Values

KEY_RESOURCE_TYPE

protected static final java.lang.String KEY_RESOURCE_TYPE

See Also:

Constant Field Values

KEY_WORKFLOW_STATE

protected static final java.lang.String KEY_WORKFLOW_STATE

See Also:

Constant Field Values

KEY_LANGUAGE

protected static final java.lang.String KEY_LANGUAGE

See Also:

Constant Field Values

KEY_LAST_MODIFIED

protected static final java.lang.String KEY_LAST_MODIFIED

See Also:

Constant Field Values

KEY_URL

protected static final java.lang.String KEY_URL

See Also:

Constant Field Values

KEY_CHECKED_OUT

protected static final java.lang.String KEY_CHECKED_OUT

See Also:

Constant Field Values

PARAMETER_KEYS

protected static final java.lang.String PARAMETER_KEYS

See Also:

Constant Field Values

KEYS

protected static final java.lang.String[] KEYS

FILTER_RESOURCE_TYPE

protected static final java.lang.String FILTER_RESOURCE_TYPE

See Also:

Constant Field Values

FILTER_WORKFLOW_STATE

protected static final java.lang.String FILTER_WORKFLOW_STATE

See Also:

Constant Field Values

FILTER_LANGUAGE

protected static final java.lang.String FILTER_LANGUAGE

See Also:

Constant Field Values

PARAMETER_FILTERS

protected static final java.lang.String PARAMETER_FILTERS

See Also:

Constant Field Values

FILTERS

protected static final java.lang.String[] FILTERS

VALUE_ALL

protected static final java.lang.String VALUE_ALL

See Also:

Constant Field Values

SORT

protected static final java.lang.String SORT

See Also:

Constant Field Values

ORDER

protected static final java.lang.String ORDER

See Also:

Constant Field Values

DESC

protected static final java.lang.String DESC

See Also:

Constant Field Values

ASC

protected static final java.lang.String ASC

See Also:

Constant Field Values

Constructor Detail

SiteOverview

public SiteOverview()

Method Detail

initParameters

protected void initParameters()

Overrides:

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

See Also:

AbstractUsecase.initParameters()

getDocuments

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

Returns:

The documents in the authoring area.

Throws:

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

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

getPublication

protected org.apache.lenya.cms.publication.Publication getPublication()
                                                               throws org.apache.lenya.cms.publication.PublicationException

Returns:

The publication.

Throws:

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

advance

public void advance()
             throws org.apache.lenya.cms.usecase.UsecaseException

Specified by:

advance in interface org.apache.lenya.cms.usecase.Usecase

Overrides:

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

Throws:

org.apache.lenya.cms.usecase.UsecaseException

See Also:

Usecase.advance()