Document (Nuxeo ECM Projects 10.1 API)

All Known Subinterfaces:

SQLDocument

All Known Implementing Classes:

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Document.BlobAccessor` An accessor that can read or write a blob and know its xpath.
`static interface`	`Document.WriteContext` Context passed to write operations to optionally record things to do at `Document.WriteContext.flush(org.nuxeo.ecm.core.model.Document)` time.

Method Summary

All Methods Instance Methods Abstract 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`	`getChangeToken()` Gets the current change token for this document.
`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.
`List<Document>`	`getChildren()` Gets 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 simple 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.
`Object`	`getValue(String xpath)` Gets a property value.
`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.
`Document.WriteContext`	`getWriteContext()` Gets a write context for the current 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`	`isRetentionActive()` Checks whether this document is under active retention.
`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`	`markUserChange()` Marks the document as being modified by a user change.
`void`	`orderBefore(String src, String dest)` Orders the given source child before the destination child.
`void`	`readDocumentPart(DocumentPart dp)` Loads a `DocumentPart` from storage.
`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 simple property value.
`void`	`setReadOnly(boolean readonly)` Sets this document as readonly or not.
`void`	`setRetentionActive(boolean retentionActive)` Sets or unsets this document as under active retention.
`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`	`setValue(String xpath, Object value)` Sets a property value.
`boolean`	`validateUserVisibleChangeToken(String changeToken)` Validates that the passed user-visible change token is compatible with the one for this document.
`void`	`visitBlobs(Consumer<Document.BlobAccessor> blobVisitor)` Visits all the blobs of this document and calls the passed blob visitor on each one.
`boolean`	`writeDocumentPart(DocumentPart dp, Document.WriteContext writeContext)` 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()
```
    Gets the parent document, or null if this is the root document.
    
    Returns:
    
    the parent document, or null
  - getType
```
DocumentType getType()
```
    Gets the type of this document.
    
    Returns:
    
    the document type
  - getPath
```
String getPath()
```
    Gets the path of this document.
    
    Returns:
    
    the path
  - setPropertyValue
```
void setPropertyValue(String name,
                      Serializable value)
```
    Sets a simple property value.
    For more generic properties described by an xpath, use setValue(java.lang.String, java.lang.Object) instead.
    
    Parameters:
    
    name - the name of the property to set
    
    value - the value to set
    
    See Also:
    
    setValue(java.lang.String, java.lang.Object)
  - setValue
```
void setValue(String xpath,
              Object value)
       throws PropertyException
```
    Sets a property value.
    The xpath may point to a partial path, in which case the value may be a complex List or Map.
    
    Parameters:
    
    xpath - the xpath of the property to set
    
    value - the value to set
    
    Throws:
    
    PropertyException - if the property does not exist or the value is of the wrong type
    
    Since:
    
    7.3
  - getPropertyValue
```
Serializable getPropertyValue(String name)
```
    Gets a simple property value.
    For more generic properties described by an xpath, use getValue(java.lang.String) instead.
    
    Parameters:
    
    name - the name of the property to get
    
    Returns:
    
    the property value or null if the property is not set
    
    See Also:
    
    getValue(java.lang.String)
  - getValue
```
Object getValue(String xpath)
         throws PropertyException
```
    Gets a property value.
    The xpath may point to a partial path, in which case the value may be a complex List or Map.
    
    Parameters:
    
    xpath - the xpath of the property to set
    
    Returns:
    
    the property value or null if the property is not set
    
    Throws:
    
    PropertyException - if the property does not exist
  - visitBlobs
```
void visitBlobs(Consumer<Document.BlobAccessor> blobVisitor)
         throws PropertyException
```
    Visits all the blobs of this document and calls the passed blob visitor on each one.
    
    Throws:
    
    PropertyException
    
    Since:
    
    7.3
  - 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()
```
    Removes this document and all its children, if any.
  - isRetentionActive
```
boolean isRetentionActive()
```
    Checks whether this document is under active retention.
    
    Since:
    
    9.3
  - setRetentionActive
```
void setRetentionActive(boolean retentionActive)
```
    Sets or unsets this document as under active retention.
    
    Since:
    
    9.3
  - getLifeCycleState
```
String getLifeCycleState()
```
    Gets the life cycle state of this document.
    
    Returns:
    
    the life cycle state
  - setCurrentLifeCycleState
```
void setCurrentLifeCycleState(String state)
```
    Sets the life cycle state of this document.
    
    Parameters:
    
    state - the life cycle state
  - getLifeCyclePolicy
```
String getLifeCyclePolicy()
```
    Gets the life cycle policy of this document.
    
    Returns:
    
    the life cycle policy
  - setLifeCyclePolicy
```
void setLifeCyclePolicy(String policy)
```
    Sets the life cycle policy of this document.
    
    Parameters:
    
    policy - the life cycle policy
  - 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()
```
    Returns the allowed state transitions for this document.
    
    Returns:
    
    a collection of state transitions
  - 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)
```
    Sets a system property.
  - getSystemProp
```
<T extends Serializable> T getSystemProp(String name,
                                         Class<T> type)
```
    Gets a system property.
  - getChangeToken
```
String getChangeToken()
```
    Gets the current change token for this document.
    
    Returns:
    
    the change token
    
    Since:
    
    9.1
  - validateUserVisibleChangeToken
```
boolean validateUserVisibleChangeToken(String changeToken)
```
    Validates that the passed user-visible change token is compatible with the one for this document.
    
    Returns:
    
    false if the change token is not valid
    
    Since:
    
    9.2
  - markUserChange
```
void markUserChange()
```
    Marks the document as being modified by a user change.
    This causes an additional change token increment and check during save.
    
    Since:
    
    9.2
  - 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
  - getWriteContext
```
Document.WriteContext getWriteContext()
```
    Gets a write context for the current document.
    
    Since:
    
    7.3
  - writeDocumentPart
```
boolean writeDocumentPart(DocumentPart dp,
                          Document.WriteContext writeContext)
                   throws PropertyException
```
    Writes a DocumentPart to storage.
    Writing data is done by DocumentPart because of per-proxy schemas.
    
    Returns:
    
    true if something changed
    
    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)
```
    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:
    
    IllegalArgumentException - if the facet does not exist
    
    Since:
    
    5.4.2
  - removeFacet
```
boolean removeFacet(String facet)
```
    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
    
    Since:
    
    5.4.2
  - setLock
```
Lock setLock(Lock lock)
```
    Sets a lock on this document.
    
    Parameters:
    
    lock - the lock to set
    
    Returns:
    
    null if locking succeeded, or the existing lock if locking failed
  - removeLock
```
Lock removeLock(String owner)
```
    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
  - getLock
```
Lock getLock()
```
    Gets the lock if one set on this document.
    
    Returns:
    
    the lock, or null if no lock is set
  - getChild
```
Document getChild(String name)
```
    Gets a child document given its name.
    Throws DocumentNotFoundException if the document could not be found.
    
    Parameters:
    
    name - the name of the child to retrieve
    
    Returns:
    
    the child if exists
    
    Throws:
    
    DocumentNotFoundException - if the child does not exist
  - getChildren
```
List<Document> getChildren()
```
    Gets the children of the document.
    Returns an empty list for non-folder documents.
    
    Returns:
    
    the children
  - getChildrenIds
```
List<String> getChildrenIds()
```
    Gets a list of the children ids.
    Returns an empty list for non-folder documents.
    
    Returns:
    
    a list of children ids.
    
    Since:
    
    1.4.1
  - hasChild
```
boolean hasChild(String name)
```
    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
  - hasChildren
```
boolean hasChildren()
```
    Tests if the document has any children.
    Returns false for non-folder documents.
    
    Returns:
    
    true if the document has children, false otherwise
  - addChild
```
Document addChild(String name,
                  String typeName)
```
    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
  - orderBefore
```
void orderBefore(String src,
                 String dest)
```
    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
  - checkIn
```
Document checkIn(String label,
                 String checkinComment)
```
    Creates a new version.
    
    Parameters:
    
    label - the version label
    
    checkinComment - the checkin comment
    
    Returns:
    
    the created version
  - checkOut
```
void checkOut()
```
  - getVersionsIds
```
List<String> getVersionsIds()
```
    Gets the list of version ids for this document.
    
    Returns:
    
    the list of version ids
    
    Since:
    
    1.4.1
  - getVersions
```
List<Document> getVersions()
```
    Gets the versions for this document.
    
    Returns:
    
    the versions of the document, or an empty list if there are no versions
  - getLastVersion
```
Document getLastVersion()
```
    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
  - getSourceDocument
```
Document getSourceDocument()
```
    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
  - restore
```
void restore(Document version)
```
    Replaces this document's content with the version specified.
    
    Parameters:
    
    version - the version to replace with
  - getVersion
```
Document getVersion(String label)
```
    Gets a version of this document, given its label.
    
    Parameters:
    
    label - the version label
    
    Returns:
    
    the version
  - isVersion
```
boolean isVersion()
```
    Checks whether this document is a version document.
    
    Returns:
    
    true if it's a version, false otherwise
  - getBaseVersion
```
Document getBaseVersion()
```
    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
  - isCheckedOut
```
boolean isCheckedOut()
```
    Checks whether this document is checked out.
    
    Returns:
    
    true if the document is checked out, or false otherwise
  - getVersionCreationDate
```
Calendar getVersionCreationDate()
```
    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
  - getCheckinComment
```
String getCheckinComment()
```
    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
  - getVersionSeriesId
```
String getVersionSeriesId()
```
    Gets the version series id.
    
    Returns:
    
    the version series id
  - getVersionLabel
```
String getVersionLabel()
```
    Gets the version label.
    
    Returns:
    
    the version label
  - isLatestVersion
```
boolean isLatestVersion()
```
    Checks whether this document is the latest version.
    
    Returns:
    
    true if this is the latest version, or false otherwise
  - isMajorVersion
```
boolean isMajorVersion()
```
    Checks whether this document is a major version.
    
    Returns:
    
    true if this is a major version, or false otherwise
  - isLatestMajorVersion
```
boolean isLatestMajorVersion()
```
    Checks whether this document is the latest major version.
    
    Returns:
    
    true if this is the latest major version, or false otherwise
  - isVersionSeriesCheckedOut
```
boolean isVersionSeriesCheckedOut()
```
    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
  - getWorkingCopy
```
Document getWorkingCopy()
```
    Gets the working copy for this document.
    
    Returns:
    
    the working copy
  - getTargetDocument
```
Document getTargetDocument()
```
    Gets the document (version or live document) to which this proxy points.
  - setTargetDocument
```
void setTargetDocument(Document target)
```
    Sets the document (version or live document) to which this proxy points.

Interface Document

Nested Class Summary

Method Summary

Method Detail

getSession

getName

getPos

getUUID

getParent

getType

getPath

setPropertyValue

setValue

getPropertyValue

getValue

visitBlobs

isFolder

setReadOnly

isReadOnly

remove

isRetentionActive

setRetentionActive

getLifeCycleState

setCurrentLifeCycleState

getLifeCyclePolicy

setLifeCyclePolicy

followTransition

getAllowedStateTransitions

isProxy

getRepositoryName

setSystemProp

getSystemProp

getChangeToken

validateUserVisibleChangeToken

markUserChange

readDocumentPart

getWriteContext

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