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

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

Change the node ID of a document.

Version:
$Id: ChangeNodeID.java 559056 2007-07-24 14:14:33Z rfrovarp $

Field Summary
protected static java.lang.String NODE_ID
           
 
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
ChangeNodeID()
           
 
Method Summary
protected  void doCheckExecutionConditions()
           
protected  void doCheckPreconditions()
           
protected  void doExecute()
           
protected  java.util.List getAllLanguageVersionNodes(org.apache.lenya.cms.publication.Document doc)
           
protected  java.lang.String getNewDocumentId()
          Returns the resulting document when the node ID would be changed.
protected  org.apache.lenya.cms.repository.Node[] getNodesToLock()
           
protected  org.apache.lenya.cms.publication.DocumentLocator getTargetLocator()
           
protected  void initParameters()
           
 
Methods inherited from class org.apache.lenya.cms.usecase.DocumentUsecase
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, 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, 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

NODE_ID

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

ChangeNodeID

public ChangeNodeID()
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
Overrides:
getNodesToLock in class org.apache.lenya.cms.usecase.AbstractUsecase
Throws:
org.apache.lenya.cms.usecase.UsecaseException
See Also:
AbstractUsecase.getNodesToLock()

getAllLanguageVersionNodes

protected java.util.List getAllLanguageVersionNodes(org.apache.lenya.cms.publication.Document doc)
                                             throws org.apache.lenya.cms.publication.DocumentException,
                                                    org.apache.lenya.transaction.TransactionException,
                                                    org.apache.lenya.cms.publication.DocumentBuildException
Throws:
org.apache.lenya.cms.publication.DocumentException
org.apache.lenya.transaction.TransactionException
org.apache.lenya.cms.publication.DocumentBuildException

doCheckPreconditions

protected void doCheckPreconditions()
                             throws java.lang.Exception
Overrides:
doCheckPreconditions in class org.apache.lenya.cms.usecase.DocumentUsecase
Throws:
java.lang.Exception
See Also:
AbstractUsecase.doCheckPreconditions()

doCheckExecutionConditions

protected void doCheckExecutionConditions()
                                   throws java.lang.Exception
Overrides:
doCheckExecutionConditions in class org.apache.lenya.cms.usecase.AbstractUsecase
Throws:
java.lang.Exception
See Also:
AbstractUsecase.doCheckExecutionConditions()

getTargetLocator

protected org.apache.lenya.cms.publication.DocumentLocator getTargetLocator()
                                                                     throws org.apache.lenya.cms.publication.DocumentBuildException,
                                                                            org.apache.lenya.cms.site.SiteException,
                                                                            org.apache.lenya.cms.publication.DocumentException
Throws:
org.apache.lenya.cms.publication.DocumentBuildException
org.apache.lenya.cms.site.SiteException
org.apache.lenya.cms.publication.DocumentException

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

getNewDocumentId

protected java.lang.String getNewDocumentId()
Returns the resulting document when the node ID would be changed.

Returns:
A document.


Copyright $ Apache Software Foundation. All Rights Reserved.