org.nuxeo.ecm.core.model
Class AbstractDocument

java.lang.Object
  org.nuxeo.ecm.core.model.AbstractDocument

All Implemented Interfaces:

Document, DocumentContainer, Lockable, PropertyContainer, VersionableDocument

Direct Known Subclasses:

JCRDocument

public abstract class AbstractDocument
extends Object
implements Document

Abstract document that implements code independent on the model implementation.

The Document implementors MUST extend this class and not directly implement the Document interface.

Author:

Julien Anguenot

Constructor Summary

AbstractDocument()

Method Summary

boolean	followTransition(String transition) Follows a given life cycle transition.
Collection<String>	getAllowedStateTransitions() Returns the allowed state transitions for this document.
String	getCurrentLifeCycleState() Returns the life cycle of the document.
String	getLifeCyclePolicy() Returns the life cycle policy of this document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.model.Document

getLastModified, getName, getParent, getPath, getRepository, getSession, getSystemProp, getType, getUUID, isDirty, isFolder, isProxy, readDocumentPart, remove, save, setDirty, setSystemProp, writeDocumentPart

Methods inherited from interface org.nuxeo.ecm.core.model.DocumentContainer

addChild, getChild, getChildren, getChildren, hasChild, hasChildren, orderBefore, removeChild, resolvePath

Methods inherited from interface org.nuxeo.ecm.core.model.PropertyContainer

exportFlatMap, exportMap, exportMap, getBoolean, getContent, getDate, getDirtyFields, getDouble, getLong, getProperties, getProperty, getPropertyIterator, getPropertyValue, getString, importFlatMap, importMap, isPropertySet, removeProperty, setBoolean, setContent, setDate, setDouble, setLong, setPropertyValue, setString

Methods inherited from interface org.nuxeo.ecm.core.versioning.VersionableDocument

checkIn, checkIn, checkOut, getLastVersion, getSourceDocument, getVersion, getVersions, hasVersions, isCheckedOut, isVersion, restore

Methods inherited from interface org.nuxeo.ecm.core.model.Lockable

getLock, isLocked, setLock, unlock

Constructor Detail

AbstractDocument

public AbstractDocument()

Method Detail

getCurrentLifeCycleState

public String getCurrentLifeCycleState()
                                throws LifeCycleException

Description copied from interface: Document

Returns the life cycle of the document.

Specified by:

getCurrentLifeCycleState in interface Document

Returns:

the life cycle as a string

Throws:

LifeCycleException

See Also:

org.nuxeo.ecm.core.lifecycle

getLifeCyclePolicy

public String getLifeCyclePolicy()
                          throws LifeCycleException

Description copied from interface: Document

Returns the life cycle policy of this document.

Specified by:

getLifeCyclePolicy in interface Document

Returns:

the life cycle policy name of this document as a string

Throws:

LifeCycleException

followTransition

public boolean followTransition(String transition)
                         throws LifeCycleException

Description copied from interface: Document

Follows a given life cycle transition.

This will update the current life cycle of the document.

Specified by:

followTransition in interface Document

Parameters:

transition - the name of the transition to follow

Returns:

a boolean representing the status if the operation

Throws:

LifeCycleException

getAllowedStateTransitions

public Collection<String> getAllowedStateTransitions()
                                              throws LifeCycleException

Description copied from interface: Document

Returns the allowed state transitions for this document.

Specified by:

getAllowedStateTransitions in interface Document

Returns:

a collection of state transitions as string

Throws:

LifeCycleException