Document (Nuxeo ECM Projects 7.1 API)

All Known Subinterfaces:

SQLDocument

All Known Implementing Classes:

DBSDocument, MockDocument, SQLDocumentLive, SQLDocumentProxy, SQLDocumentVersion
```
public interface Document
```
A low-level document from a Session.

Method Summary

Methods
Modifier and Type	Method and Description
`Document`	`addChild(String name, String typeName)` Creates a new child document of the given type.
`boolean`	`addFacet(String facet)` Adds a facet to this document.
`Document`	`checkIn(String label, String checkinComment)` Creates a new version.
`void`	`checkOut()`
`void`	`followTransition(String transition)` Follows a given life cycle transition.
`Set<String>`	`getAllFacets()` Gets the facets available on this document (from the type and the instance facets).
`Collection<String>`	`getAllowedStateTransitions()` Returns the allowed state transitions for this document.
`Document`	`getBaseVersion()` Gets the version to which a checked in document is linked.
`String`	`getCheckinComment()` Gets the version check in comment of this document if it's a version or a proxy.
`Document`	`getChild(String name)` Gets a child document given its name.
`Iterator<Document>`	`getChildren()` Gets an iterator over the children of the document.
`List<String>`	`getChildrenIds()` Gets a list of the children ids.
`String[]`	`getFacets()` Gets the facets defined on this document instance.
`Document`	`getLastVersion()` Gets the last version of this document.
`String`	`getLifeCyclePolicy()` Gets the life cycle policy of this document.
`String`	`getLifeCycleState()` Gets the life cycle state of this document.
`Lock`	`getLock()` Gets the lock if one set on this document.
`String`	`getName()` Gets the name of this document.
`Document`	`getParent()` Gets the parent document, or `null` if this is the root document.
`String`	`getPath()` Gets the path of this document.
`Long`	`getPos()` Gets the document's position in its containing folder (if ordered).
`Serializable`	`getPropertyValue(String name)` Gets a property value.
`String`	`getRepositoryName()` Gets the repository in which the document lives.
`Session`	`getSession()` Gets the session that owns this document.
`Document`	`getSourceDocument()` Gets the source for this document.
`<T extends Serializable> T`	`getSystemProp(String name, Class<T> type)` Gets a system property.
`Document`	`getTargetDocument()` Gets the document (version or live document) to which this proxy points.
`DocumentType`	`getType()` Gets the type of this document.
`String`	`getUUID()` Gets this document's UUID.
`Document`	`getVersion(String label)` Gets a version of this document, given its label.
`Calendar`	`getVersionCreationDate()` Gets the version creation date of this document if it's a version or a proxy.
`String`	`getVersionLabel()` Gets the version label.
`List<Document>`	`getVersions()` Gets the versions for this document.
`String`	`getVersionSeriesId()` Gets the version series id.
`List<String>`	`getVersionsIds()` Gets the list of version ids for this document.
`Document`	`getWorkingCopy()` Gets the working copy for this document.
`boolean`	`hasChild(String name)` Checks whether this document has a child of the given name.
`boolean`	`hasChildren()` Tests if the document has any children.
`boolean`	`hasFacet(String facet)` Checks whether this document has a given facet, either from its type or added on the instance.
`boolean`	`isCheckedOut()` Checks whether this document is checked out.
`boolean`	`isFolder()` Checks whether this document is a folder.
`boolean`	`isLatestMajorVersion()` Checks whether this document is the latest major version.
`boolean`	`isLatestVersion()` Checks whether this document is the latest version.
`boolean`	`isMajorVersion()` Checks whether this document is a major version.
`boolean`	`isProxy()` Checks whether or not this document is a proxy.
`boolean`	`isReadOnly()` Checks whether this document is readonly or not.
`boolean`	`isVersion()` Checks whether this document is a version document.
`boolean`	`isVersionSeriesCheckedOut()` Checks if there is a checked out working copy for the version series of this document.
`void`	`orderBefore(String src, String dest)` Orders the given source child before the destination child.
`void`	`readDocumentPart(DocumentPart dp)` Loads a `DocumentPart` from storage.
`Map<String,Serializable>`	`readPrefetch(ComplexType complexType, Set<String> xpaths)` Reads a set of prefetched fields.
`void`	`remove()` Removes this document and all its children, if any.
`boolean`	`removeFacet(String facet)` Removes a facet from this document.
`Lock`	`removeLock(String owner)` Removes a lock from this document.
`void`	`restore(Document version)` Replaces this document's content with the version specified.
`void`	`setCurrentLifeCycleState(String state)` Sets the life cycle state of this document.
`void`	`setLifeCyclePolicy(String policy)` Sets the life cycle policy of this document.
`Lock`	`setLock(Lock lock)` Sets a lock on this document.
`void`	`setPropertyValue(String name, Serializable value)` Sets a property value.
`void`	`setReadOnly(boolean readonly)` Sets this document as readonly or not.
`void`	`setSystemProp(String name, Serializable value)` Sets a system property.
`void`	`setTargetDocument(Document target)` Sets the document (version or live document) to which this proxy points.
`void`	`writeDocumentPart(DocumentPart dp)` Writes a `DocumentPart` to storage.

- Method Detail
  - getSession
```
Session getSession()
```
    Gets the session that owns this document.
    
    Returns:
    the session
  - getName
```
String getName()
```
    Gets the name of this document.
    
    Returns:
    the document name
  - getPos
```
Long getPos()
```
    Gets the document's position in its containing folder (if ordered).
    
    Returns:
    the position
    Since:
    
    6.0
  - getUUID
```
String getUUID()
```
    Gets this document's UUID.
    
    Returns:
    the document UUID
  - getParent
```
Document getParent()
                   throws DocumentException
```
    Gets the parent document, or null if this is the root document.
    
    Returns:
    the parent document, or null
    
    Throws:
    
    DocumentException
  - getType
```
DocumentType getType()
```
    Gets the type of this document.
    
    Returns:
    the document type
  - getPath
```
String getPath()
               throws DocumentException
```
    Gets the path of this document.
    
    Returns:
    the path
    
    Throws:
    
    DocumentException
  - setPropertyValue
```
void setPropertyValue(String name,
                    Serializable value)
                      throws DocumentException
```
    Sets a property value.
    
    Parameters:
    name - the name of the property to set
    value - the value to set
    
    Throws:
    
    DocumentException
  - getPropertyValue
```
Serializable getPropertyValue(String name)
                              throws DocumentException
```
    Gets a property value.
    
    Parameters:
    name - the name of the property to get
    
    Returns:
    the property value or null if the property is not set
    
    Throws:
    
    DocumentException
  - isFolder
```
boolean isFolder()
```
    Checks whether this document is a folder.
    
    Returns:
    true if the document is a folder, false otherwise
  - setReadOnly
```
void setReadOnly(boolean readonly)
```
    Sets this document as readonly or not.
    
    Since:
    
    5.9.2
  - isReadOnly
```
boolean isReadOnly()
```
    Checks whether this document is readonly or not.
    
    Since:
    
    5.9.2
  - remove
```
void remove()
            throws DocumentException
```
    Removes this document and all its children, if any.
    
    Throws:
    
    DocumentException
  - getLifeCycleState
```
String getLifeCycleState()
                         throws LifeCycleException
```
    Gets the life cycle state of this document.
    
    Returns:
    the life cycle state
    
    Throws:
    
    LifeCycleException
  - setCurrentLifeCycleState
```
void setCurrentLifeCycleState(String state)
                              throws LifeCycleException
```
    Sets the life cycle state of this document.
    
    Parameters:
    state - the life cycle state
    
    Throws:
    
    LifeCycleException
  - getLifeCyclePolicy
```
String getLifeCyclePolicy()
                          throws LifeCycleException
```
    Gets the life cycle policy of this document.
    
    Returns:
    the life cycle policy
    
    Throws:
    
    LifeCycleException
  - setLifeCyclePolicy
```
void setLifeCyclePolicy(String policy)
                        throws LifeCycleException
```
    Sets the life cycle policy of this document.
    
    Parameters:
    policy - the life cycle policy
    
    Throws:
    
    LifeCycleException
  - followTransition
```
void followTransition(String transition)
                      throws LifeCycleException
```
    Follows a given life cycle transition.
    This will update the life cycle state of the document.
    
    Parameters:
    transition - the name of the transition to follow
    
    Throws:
    
    LifeCycleException
  - getAllowedStateTransitions
```
Collection<String> getAllowedStateTransitions()
                                              throws LifeCycleException
```
    Returns the allowed state transitions for this document.
    
    Returns:
    a collection of state transitions
    
    Throws:
    
    LifeCycleException
  - isProxy
```
boolean isProxy()
```
    Checks whether or not this document is a proxy.
    
    Returns:
    true if this document is a proxy, false otherwise
  - getRepositoryName
```
String getRepositoryName()
```
    Gets the repository in which the document lives.
    
    Returns:
    the repository name.
  - setSystemProp
```
void setSystemProp(String name,
                 Serializable value)
                   throws DocumentException
```
    Sets a system property.
    
    Throws:
    
    DocumentException
  - getSystemProp
```
<T extends Serializable> T getSystemProp(String name,
                                       Class<T> type)
                                     throws DocumentException
```
    Gets a system property.
    
    Throws:
    
    DocumentException
  - readDocumentPart
```
void readDocumentPart(DocumentPart dp)
                      throws PropertyException
```
    Loads a DocumentPart from storage.
    Reading data is done by DocumentPart because of per-proxy schemas.
    
    Throws:
    
    PropertyException
  - readPrefetch
```
Map<String,Serializable> readPrefetch(ComplexType complexType,
                                    Set<String> xpaths)
                                      throws PropertyException
```
    Reads a set of prefetched fields.
    Reading data is done by ComplexType because of per-proxy schemas.
    
    Throws:
    
    PropertyException
    Since:
    
    5.9.4
  - writeDocumentPart
```
void writeDocumentPart(DocumentPart dp)
                       throws PropertyException
```
    Writes a DocumentPart to storage.
    Writing data is done by DocumentPart because of per-proxy schemas.
    
    Throws:
    
    PropertyException
  - getAllFacets
```
Set<String> getAllFacets()
```
    Gets the facets available on this document (from the type and the instance facets).
    
    Returns:
    the facets
    Since:
    
    5.4.2
  - getFacets
```
String[] getFacets()
```
    Gets the facets defined on this document instance. The type facets are not returned.
    
    Returns:
    the facets
    Since:
    
    5.4.2
  - hasFacet
```
boolean hasFacet(String facet)
```
    Checks whether this document has a given facet, either from its type or added on the instance.
    
    Parameters:
    facet - the facet name
    
    Returns:
    true if the document has the facet
    Since:
    
    5.4.2
  - addFacet
```
boolean addFacet(String facet)
                 throws DocumentException
```
    Adds a facet to this document.
    Does nothing if the facet was already present on the document.
    
    Parameters:
    facet - the facet name
    
    Returns:
    true if the facet was added, or false if it is already present
    
    Throws:
    
    DocumentException - if the facet does not exist
    Since:
    
    5.4.2
  - removeFacet
```
boolean removeFacet(String facet)
                    throws DocumentException
```
    Removes a facet from this document.
    It's not possible to remove a facet coming from the document type.
    
    Parameters:
    facet - the facet name
    
    Returns:
    true if the facet was removed, or false if it isn't present or is present on the type or does not exit
    
    Throws:
    
    DocumentException
    Since:
    
    5.4.2
  - setLock
```
Lock setLock(Lock lock)
             throws DocumentException
```
    Sets a lock on this document.
    
    Parameters:
    lock - the lock to set
    
    Returns:
    null if locking succeeded, or the existing lock if locking failed
    
    Throws:
    
    DocumentException
  - removeLock
```
Lock removeLock(String owner)
                throws DocumentException
```
    Removes a lock from this document.
    
    Parameters:
    the - owner to check, or null for no check
    
    Returns:
    null if there was no lock or if removal succeeded, or a lock if it blocks removal due to owner mismatch
    
    Throws:
    
    DocumentException
  - getLock
```
Lock getLock()
             throws DocumentException
```
    Gets the lock if one set on this document.
    
    Returns:
    the lock, or null if no lock is set
    
    Throws:
    
    DocumentException
  - getChild
```
Document getChild(String name)
                  throws DocumentException
```
    Gets a child document given its name.
    Throws NoSuchDocumentException if the document could not be found.
    
    Parameters:
    name - the name of the child to retrieve
    
    Returns:
    the child if exists
    
    Throws:
    
    NoSuchDocumentException - if the child does not exist
    
    DocumentException
  - getChildren
```
Iterator<Document> getChildren()
                               throws DocumentException
```
    Gets an iterator over the children of the document.
    Returns an empty iterator for non-folder documents.
    
    Returns:
    the children iterator
    
    Throws:
    
    DocumentException
  - getChildrenIds
```
List<String> getChildrenIds()
                            throws DocumentException
```
    Gets a list of the children ids.
    Returns an empty list for non-folder documents.
    
    Returns:
    a list of children ids.
    
    Throws:
    
    DocumentException
    Since:
    
    1.4.1
  - hasChild
```
boolean hasChild(String name)
                 throws DocumentException
```
    Checks whether this document has a child of the given name.
    Returns false for non-folder documents.
    
    Parameters:
    name - the name of the child to check
    
    Returns:
    true if the child exists, false otherwise
    
    Throws:
    
    DocumentException
  - hasChildren
```
boolean hasChildren()
                    throws DocumentException
```
    Tests if the document has any children.
    Returns false for non-folder documents.
    
    Returns:
    true if the document has children, false otherwise
    
    Throws:
    
    DocumentException
  - addChild
```
Document addChild(String name,
                String typeName)
                  throws DocumentException
```
    Creates a new child document of the given type.
    Throws an error if this document is not a folder.
    
    Parameters:
    name - the name of the new child to create
    typeName - the type of the child to create
    
    Returns:
    the newly created document
    
    Throws:
    
    DocumentException
  - orderBefore
```
void orderBefore(String src,
               String dest)
                 throws DocumentException
```
    Orders the given source child before the destination child.
    Both source and destination must be names that point to child documents of this document. The source document will be placed before the destination one. If destination is null, the source document will be appended at the end of the children list.
    
    Parameters:
    src - the document to move
    dest - the document before which to place the source document
    
    Throws:
    
    DocumentException - if this document is not an orderable folder
  - checkIn
```
Document checkIn(String label,
               String checkinComment)
                 throws DocumentException
```
    Creates a new version.
    
    Parameters:
    label - the version label
    checkinComment - the checkin comment
    
    Returns:
    the created version
    
    Throws:
    
    DocumentException
  - checkOut
```
void checkOut()
              throws DocumentException
```
    Throws:
    
    DocumentException
  - getVersionsIds
```
List<String> getVersionsIds()
                            throws DocumentException
```
    Gets the list of version ids for this document.
    
    Returns:
    the list of version ids
    
    Throws:
    
    DocumentException
    Since:
    
    1.4.1
  - getVersions
```
List<Document> getVersions()
                           throws DocumentException
```
    Gets the versions for this document.
    
    Returns:
    the versions of the document, or an empty list if there are no versions
    
    Throws:
    
    DocumentException
  - getLastVersion
```
Document getLastVersion()
                        throws DocumentException
```
    Gets the last version of this document.
    Returns null if there is no version at all.
    
    Returns:
    the last version, or null if there is no version
    
    Throws:
    
    DocumentException
  - getSourceDocument
```
Document getSourceDocument()
                           throws DocumentException
```
    Gets the source for this document.
    For a version, it's the working copy.
    For a proxy, it's the version the proxy points to.
    
    Returns:
    the source document
    
    Throws:
    
    DocumentException
  - restore
```
void restore(Document version)
             throws DocumentException
```
    Replaces this document's content with the version specified.
    
    Parameters:
    version - the version to replace with
    
    Throws:
    
    DocumentException
  - getVersion
```
Document getVersion(String label)
                    throws DocumentException
```
    Gets a version of this document, given its label.
    
    Parameters:
    label - the version label
    
    Returns:
    the version
    
    Throws:
    
    DocumentException
  - isVersion
```
boolean isVersion()
```
    Checks whether this document is a version document.
    
    Returns:
    true if it's a version, false otherwise
  - getBaseVersion
```
Document getBaseVersion()
                        throws DocumentException
```
    Gets the version to which a checked in document is linked.
    Returns null for a checked out document or a version or a proxy.
    
    Returns:
    the version, or null
    
    Throws:
    
    DocumentException
  - isCheckedOut
```
boolean isCheckedOut()
                     throws DocumentException
```
    Checks whether this document is checked out.
    
    Returns:
    true if the document is checked out, or false otherwise
    
    Throws:
    
    DocumentException
  - getVersionCreationDate
```
Calendar getVersionCreationDate()
                                throws DocumentException
```
    Gets the version creation date of this document if it's a version or a proxy.
    
    Returns:
    the version creation date, or null if it's not a version or a proxy
    
    Throws:
    
    DocumentException
  - getCheckinComment
```
String getCheckinComment()
                         throws DocumentException
```
    Gets the version check in comment of this document if it's a version or a proxy.
    
    Returns:
    the check in comment, or null if it's not a version or a proxy
    
    Throws:
    
    DocumentException
  - getVersionSeriesId
```
String getVersionSeriesId()
                          throws DocumentException
```
    Gets the version series id.
    
    Returns:
    the version series id
    
    Throws:
    
    DocumentException
  - getVersionLabel
```
String getVersionLabel()
                       throws DocumentException
```
    Gets the version label.
    
    Returns:
    the version label
    
    Throws:
    
    DocumentException
  - isLatestVersion
```
boolean isLatestVersion()
                        throws DocumentException
```
    Checks whether this document is the latest version.
    
    Returns:
    true if this is the latest version, or false otherwise
    
    Throws:
    
    DocumentException
  - isMajorVersion
```
boolean isMajorVersion()
                       throws DocumentException
```
    Checks whether this document is a major version.
    
    Returns:
    true if this is a major version, or false otherwise
    
    Throws:
    
    DocumentException
  - isLatestMajorVersion
```
boolean isLatestMajorVersion()
                             throws DocumentException
```
    Checks whether this document is the latest major version.
    
    Returns:
    true if this is the latest major version, or false otherwise
    
    Throws:
    
    DocumentException
  - isVersionSeriesCheckedOut
```
boolean isVersionSeriesCheckedOut()
                                  throws DocumentException
```
    Checks if there is a checked out working copy for the version series of this document.
    
    Returns:
    true if there is a checked out working copy
    
    Throws:
    
    DocumentException
  - getWorkingCopy
```
Document getWorkingCopy()
                        throws DocumentException
```
    Gets the working copy for this document.
    
    Returns:
    the working copy
    
    Throws:
    
    DocumentException
  - getTargetDocument
```
Document getTargetDocument()
                           throws DocumentException
```
    Gets the document (version or live document) to which this proxy points.
    
    Throws:
    
    DocumentException
  - setTargetDocument
```
void setTargetDocument(Document target)
                       throws DocumentException
```
    Sets the document (version or live document) to which this proxy points.
    
    Throws:
    
    DocumentException

Interface Document

Method Summary

Method Detail

getSession

getName

getPos

getUUID

getParent

getType

getPath

setPropertyValue

getPropertyValue

isFolder

setReadOnly

isReadOnly

remove

getLifeCycleState

setCurrentLifeCycleState

getLifeCyclePolicy

setLifeCyclePolicy

followTransition

getAllowedStateTransitions

isProxy

getRepositoryName

setSystemProp

getSystemProp

readDocumentPart

readPrefetch

writeDocumentPart

getAllFacets

getFacets

hasFacet

addFacet

removeFacet

setLock

removeLock

getLock

getChild

getChildren

getChildrenIds

hasChild

hasChildren

addChild

orderBefore

checkIn

checkOut

getVersionsIds

getVersions

getLastVersion

getSourceDocument

restore

getVersion

isVersion

getBaseVersion

isCheckedOut

getVersionCreationDate

getCheckinComment

getVersionSeriesId

getVersionLabel

isLatestVersion

isMajorVersion

isLatestMajorVersion

isVersionSeriesCheckedOut

getWorkingCopy

getTargetDocument

setTargetDocument