org.apache.lenya.cms.usecases.webdav
Class FilePropfind

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.lenya.cms.usecase.AbstractUsecase
          extended by org.apache.lenya.cms.usecase.DocumentUsecase
              extended by org.apache.lenya.cms.site.usecases.SiteUsecase
                  extended by org.apache.lenya.cms.usecases.webdav.FilePropfind
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 FilePropfind
extends org.apache.lenya.cms.site.usecases.SiteUsecase

Usecase to display the overview tab in the site area for a document.


Field Summary
protected static java.lang.String DATEFORMAT
           
protected static java.lang.String DOCUMENT
           
protected static java.lang.String DOCUMENTS
           
protected static java.lang.String RC
           
protected static java.lang.String SOURCEURL
           
 
Fields inherited from class org.apache.lenya.cms.usecase.DocumentUsecase
TARGET_DOCUMENT
 
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
FilePropfind()
           
 
Method Summary
 java.lang.String getArea()
           
protected  org.apache.lenya.cms.publication.Publication getPublication()
          Access to the current publication.
protected  org.apache.lenya.cms.publication.Document getTargetDocument(boolean success)
          Returns the document to be redirected to after the usecase has been completed.
protected  void initParameters()
           
 
Methods inherited from class org.apache.lenya.cms.usecase.DocumentUsecase
doCheckPreconditions, getSourceDocument, getSourceURL, getTargetURL, setDefaultTargetURL, setTargetDocument
 
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, doExecute, doInitialize, dumpErrorMessages, execute, getBooleanCheckboxParameter, getContext, getDocumentFactory, getErrorMessages, getExitQueryString, getInfoMessages, getName, getNodesToLock, getParameter, getParameter, getParameterAsBoolean, getParameterAsInteger, getParameterAsString, getParameterAsString, getParameterNames, getParameters, getPart, getSession, getStateMachine, getView, hasErrors, hasInfoMessages, initialize, initializeParametersIfNotDone, isOptimistic, lockInvolvedObjects, lockInvolvedObjects, prepareView, service, 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

DOCUMENT

protected static final java.lang.String DOCUMENT
See Also:
Constant Field Values

DOCUMENTS

protected static final java.lang.String DOCUMENTS
See Also:
Constant Field Values

SOURCEURL

protected static final java.lang.String SOURCEURL
See Also:
Constant Field Values

DATEFORMAT

protected static final java.lang.String DATEFORMAT
See Also:
Constant Field Values

RC

protected static final java.lang.String RC
See Also:
Constant Field Values
Constructor Detail

FilePropfind

public FilePropfind()
Method Detail

initParameters

protected void initParameters()
Overrides:
initParameters in class org.apache.lenya.cms.usecase.AbstractUsecase
See Also:
AbstractUsecase.initParameters()

getArea

public java.lang.String getArea()
Returns:
The area without the "info-" prefix.

getTargetDocument

protected org.apache.lenya.cms.publication.Document getTargetDocument(boolean success)
Returns the document to be redirected to after the usecase has been completed. If the parameter success is false, the source document is returned (override this method to change this behaviour).

Overrides:
getTargetDocument in class org.apache.lenya.cms.usecase.DocumentUsecase
Parameters:
success - If the usecase was successfully completed.
Returns:
A document.

getPublication

protected org.apache.lenya.cms.publication.Publication getPublication()
Access to the current publication. Use this when the publication is not yet known in the usecase: e.g. when creating a global asset. When adding a resource or a child to a document, access the publication via that document's interface instead.

Returns:
the publication in which the use-case is being executed


Copyright $ Apache Software Foundation. All Rights Reserved.