org.apache.lenya.cms.editors
Class EditDocument

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.lenya.cms.usecase.AbstractUsecase
          org.apache.lenya.cms.usecase.DocumentUsecase
              org.apache.lenya.cms.editors.EditDocument

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 EditDocument
extends org.apache.lenya.cms.usecase.DocumentUsecase

You can use this usecase to save a document. It reads XML data from a source and saves as the content of the current document.

• If the document's resource type supports validation, the XML document is validated and not saved if validation errors occur.
• All URL-based internal links in the XML source are converted to UUID-based links before saving.
• A workflow event is invoked. The event defaults to "edit", you can override it using the event parameter.

Parameters:

• sourceUri - the URI to read the XML data from
• event - the workflow event to invoke

A typical usage scenario is to save XML data entered in a form. In this case, the sourceUri parameter refers to a Cocoon pipeline featuring the stream generator.

Version:

$Id: EditDocument.java 509150 2007-02-19 10:43:07Z andreas $

Field Summary

protected static java.lang.String	DEFAULT_EVENT
protected static java.lang.String	EVENT
static java.lang.String	SOURCE_URI The URI to copy the document source from.

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

DOCUMENT, 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

EditDocument()

Method Summary

protected void	doExecute()
protected org.apache.lenya.cms.repository.Node[]	getNodesToLock()

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

doCheckPreconditions, getSourceDocument, getSourceURL, getTargetDocument, 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, doInitialize, dumpErrorMessages, execute, getBooleanCheckboxParameter, getContext, getDocumentFactory, getErrorMessages, getExitQueryString, getInfoMessages, getName, getParameter, getParameter, getParameterAsBoolean, getParameterAsInteger, getParameterAsString, getParameterAsString, getParameterNames, getParameters, getPart, getSession, getStateMachine, getView, hasErrors, hasInfoMessages, initialize, initializeParametersIfNotDone, initParameters, 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

EVENT

protected static final java.lang.String EVENT

See Also:

Constant Field Values

DEFAULT_EVENT

protected static final java.lang.String DEFAULT_EVENT

See Also:

Constant Field Values

SOURCE_URI

public static final java.lang.String SOURCE_URI

The URI to copy the document source from.

See Also:

Constant Field Values

Constructor Detail

EditDocument

public EditDocument()

Method Detail

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()

getNodesToLock

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

Overrides:

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

Throws:

org.apache.lenya.cms.usecase.UsecaseException

See Also:

AbstractUsecase.getNodesToLock()