DBSDocument (Nuxeo ECM Projects 7.2-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.core.storage.dbs.DBSDocument

All Implemented Interfaces:

Document
```
public class DBSDocument
extends Object
implements Document
```
Implementation of a Document for Document-Based Storage. The document is stored as a JSON-like Map. The keys of the Map are the property names (including special names for system properties), and the values Map are Serializable values, either:
- a scalar (String, Long, Double, Boolean, Calendar, Binary),
- an array of scalars,
- a List of Maps, recursively,
- or another Map, recursively.
An ACP value is stored as a list of maps. Each map has a keys for the ACL name and the actual ACL which is a list of ACEs. An ACE is a map having as keys username, permission, and grant.
Since:

5.9.4

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_OCTET_STREAM`
`static String`	`KEY_ACE_GRANT`
`static String`	`KEY_ACE_PERMISSION`
`static String`	`KEY_ACE_USER`
`static String`	`KEY_ACL`
`static String`	`KEY_ACL_NAME`
`static String`	`KEY_ACP`
`static String`	`KEY_ANCESTOR_IDS`
`static String`	`KEY_BASE_VERSION_ID`
`static String`	`KEY_BLOB_DATA`
`static String`	`KEY_BLOB_DIGEST`
`static String`	`KEY_BLOB_ENCODING`
`static String`	`KEY_BLOB_LENGTH`
`static String`	`KEY_BLOB_MIME_TYPE`
`static String`	`KEY_BLOB_NAME`
`static String`	`KEY_FULLTEXT_BINARY`
`static String`	`KEY_FULLTEXT_JOBID`
`static String`	`KEY_FULLTEXT_SCORE`
`static String`	`KEY_FULLTEXT_SIMPLE`
`static String`	`KEY_ID`
`static String`	`KEY_IS_CHECKED_IN`
`static String`	`KEY_IS_LATEST_MAJOR_VERSION`
`static String`	`KEY_IS_LATEST_VERSION`
`static String`	`KEY_IS_PROXY`
`static String`	`KEY_IS_VERSION`
`static String`	`KEY_LIFECYCLE_POLICY`
`static String`	`KEY_LIFECYCLE_STATE`
`static String`	`KEY_LOCK_CREATED`
`static String`	`KEY_LOCK_OWNER`
`static String`	`KEY_MAJOR_VERSION`
`static String`	`KEY_MINOR_VERSION`
`static String`	`KEY_MIXIN_TYPES`
`static String`	`KEY_NAME`
`static String`	`KEY_PARENT_ID`
`static String`	`KEY_PATH_INTERNAL`
`static String`	`KEY_POS`
`static String`	`KEY_PREFIX`
`static String`	`KEY_PRIMARY_TYPE`
`static String`	`KEY_PROXY_IDS`
`static String`	`KEY_PROXY_TARGET_ID`
`static String`	`KEY_PROXY_VERSION_SERIES_ID`
`static String`	`KEY_READ_ACL`
`static String`	`KEY_VERSION_CREATED`
`static String`	`KEY_VERSION_DESCRIPTION`
`static String`	`KEY_VERSION_LABEL`
`static String`	`KEY_VERSION_SERIES_ID`
`static String`	`SYSPROP_FULLTEXT_BINARY`
`static String`	`SYSPROP_FULLTEXT_JOBID`
`static String`	`SYSPROP_FULLTEXT_SIMPLE`

Constructor Summary

Constructors
Constructor and Description

DBSDocument(DBSDocumentState docState, DocumentType type, DBSSession session, boolean readonly)

Constructors
Constructor and Description
`DBSDocument(DBSDocumentState docState, DocumentType type, DBSSession session, boolean readonly)`

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()`
`boolean`	`equals(Object other)`
`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.
`int`	`hashCode()`
`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 lifeCycleState)` 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.
`String`	`toString()`
`void`	`writeDocumentPart(DocumentPart dp)` Writes a `DocumentPart` to storage.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SYSPROP_FULLTEXT_SIMPLE
```
public static final String SYSPROP_FULLTEXT_SIMPLE
```
    See Also:
    Constant Field Values
  - SYSPROP_FULLTEXT_BINARY
```
public static final String SYSPROP_FULLTEXT_BINARY
```
    See Also:
    Constant Field Values
  - SYSPROP_FULLTEXT_JOBID
```
public static final String SYSPROP_FULLTEXT_JOBID
```
    See Also:
    Constant Field Values
  - KEY_PREFIX
```
public static final String KEY_PREFIX
```
    See Also:
    Constant Field Values
  - KEY_ID
```
public static final String KEY_ID
```
    See Also:
    Constant Field Values
  - KEY_PARENT_ID
```
public static final String KEY_PARENT_ID
```
    See Also:
    Constant Field Values
  - KEY_ANCESTOR_IDS
```
public static final String KEY_ANCESTOR_IDS
```
    See Also:
    Constant Field Values
  - KEY_PRIMARY_TYPE
```
public static final String KEY_PRIMARY_TYPE
```
    See Also:
    Constant Field Values
  - KEY_MIXIN_TYPES
```
public static final String KEY_MIXIN_TYPES
```
    See Also:
    Constant Field Values
  - KEY_NAME
```
public static final String KEY_NAME
```
    See Also:
    Constant Field Values
  - KEY_POS
```
public static final String KEY_POS
```
    See Also:
    Constant Field Values
  - KEY_ACP
```
public static final String KEY_ACP
```
    See Also:
    Constant Field Values
  - KEY_ACL_NAME
```
public static final String KEY_ACL_NAME
```
    See Also:
    Constant Field Values
  - KEY_PATH_INTERNAL
```
public static final String KEY_PATH_INTERNAL
```
    See Also:
    Constant Field Values
  - KEY_ACL
```
public static final String KEY_ACL
```
    See Also:
    Constant Field Values
  - KEY_ACE_USER
```
public static final String KEY_ACE_USER
```
    See Also:
    Constant Field Values
  - KEY_ACE_PERMISSION
```
public static final String KEY_ACE_PERMISSION
```
    See Also:
    Constant Field Values
  - KEY_ACE_GRANT
```
public static final String KEY_ACE_GRANT
```
    See Also:
    Constant Field Values
  - KEY_READ_ACL
```
public static final String KEY_READ_ACL
```
    See Also:
    Constant Field Values
  - KEY_IS_CHECKED_IN
```
public static final String KEY_IS_CHECKED_IN
```
    See Also:
    Constant Field Values
  - KEY_IS_VERSION
```
public static final String KEY_IS_VERSION
```
    See Also:
    Constant Field Values
  - KEY_IS_LATEST_VERSION
```
public static final String KEY_IS_LATEST_VERSION
```
    See Also:
    Constant Field Values
  - KEY_IS_LATEST_MAJOR_VERSION
```
public static final String KEY_IS_LATEST_MAJOR_VERSION
```
    See Also:
    Constant Field Values
  - KEY_MAJOR_VERSION
```
public static final String KEY_MAJOR_VERSION
```
    See Also:
    Constant Field Values
  - KEY_MINOR_VERSION
```
public static final String KEY_MINOR_VERSION
```
    See Also:
    Constant Field Values
  - KEY_VERSION_SERIES_ID
```
public static final String KEY_VERSION_SERIES_ID
```
    See Also:
    Constant Field Values
  - KEY_VERSION_CREATED
```
public static final String KEY_VERSION_CREATED
```
    See Also:
    Constant Field Values
  - KEY_VERSION_LABEL
```
public static final String KEY_VERSION_LABEL
```
    See Also:
    Constant Field Values
  - KEY_VERSION_DESCRIPTION
```
public static final String KEY_VERSION_DESCRIPTION
```
    See Also:
    Constant Field Values
  - KEY_BASE_VERSION_ID
```
public static final String KEY_BASE_VERSION_ID
```
    See Also:
    Constant Field Values
  - KEY_IS_PROXY
```
public static final String KEY_IS_PROXY
```
    See Also:
    Constant Field Values
  - KEY_PROXY_TARGET_ID
```
public static final String KEY_PROXY_TARGET_ID
```
    See Also:
    Constant Field Values
  - KEY_PROXY_VERSION_SERIES_ID
```
public static final String KEY_PROXY_VERSION_SERIES_ID
```
    See Also:
    Constant Field Values
  - KEY_PROXY_IDS
```
public static final String KEY_PROXY_IDS
```
    See Also:
    Constant Field Values
  - KEY_LIFECYCLE_POLICY
```
public static final String KEY_LIFECYCLE_POLICY
```
    See Also:
    Constant Field Values
  - KEY_LIFECYCLE_STATE
```
public static final String KEY_LIFECYCLE_STATE
```
    See Also:
    Constant Field Values
  - KEY_LOCK_OWNER
```
public static final String KEY_LOCK_OWNER
```
    See Also:
    Constant Field Values
  - KEY_LOCK_CREATED
```
public static final String KEY_LOCK_CREATED
```
    See Also:
    Constant Field Values
  - KEY_BLOB_NAME
```
public static final String KEY_BLOB_NAME
```
    See Also:
    Constant Field Values
  - KEY_BLOB_MIME_TYPE
```
public static final String KEY_BLOB_MIME_TYPE
```
    See Also:
    Constant Field Values
  - KEY_BLOB_ENCODING
```
public static final String KEY_BLOB_ENCODING
```
    See Also:
    Constant Field Values
  - KEY_BLOB_DIGEST
```
public static final String KEY_BLOB_DIGEST
```
    See Also:
    Constant Field Values
  - KEY_BLOB_LENGTH
```
public static final String KEY_BLOB_LENGTH
```
    See Also:
    Constant Field Values
  - KEY_BLOB_DATA
```
public static final String KEY_BLOB_DATA
```
    See Also:
    Constant Field Values
  - KEY_FULLTEXT_SIMPLE
```
public static final String KEY_FULLTEXT_SIMPLE
```
    See Also:
    Constant Field Values
  - KEY_FULLTEXT_BINARY
```
public static final String KEY_FULLTEXT_BINARY
```
    See Also:
    Constant Field Values
  - KEY_FULLTEXT_JOBID
```
public static final String KEY_FULLTEXT_JOBID
```
    See Also:
    Constant Field Values
  - KEY_FULLTEXT_SCORE
```
public static final String KEY_FULLTEXT_SCORE
```
    See Also:
    Constant Field Values
  - APPLICATION_OCTET_STREAM
```
public static final String APPLICATION_OCTET_STREAM
```
    See Also:
    Constant Field Values
- Constructor Detail
  - DBSDocument
```
public DBSDocument(DBSDocumentState docState,
           DocumentType type,
           DBSSession session,
           boolean readonly)
```
- Method Detail
  - getType
```
public DocumentType getType()
```
    Description copied from interface: Document
    
    Gets the type of this document.
    
    Specified by:
    
    getType in interface Document
    
    Returns:
    the document type
  - getSession
```
public Session getSession()
```
    Description copied from interface: Document
    
    Gets the session that owns this document.
    
    Specified by:
    
    getSession in interface Document
    
    Returns:
    the session
  - getRepositoryName
```
public String getRepositoryName()
```
    Description copied from interface: Document
    
    Gets the repository in which the document lives.
    
    Specified by:
    
    getRepositoryName in interface Document
    
    Returns:
    the repository name.
  - getUUID
```
public String getUUID()
```
    Description copied from interface: Document
    
    Gets this document's UUID.
    
    Specified by:
    
    getUUID in interface Document
    
    Returns:
    the document UUID
  - getName
```
public String getName()
```
    Description copied from interface: Document
    
    Gets the name of this document.
    
    Specified by:
    
    getName in interface Document
    
    Returns:
    the document name
  - getPos
```
public Long getPos()
```
    Description copied from interface: Document
    
    Gets the document's position in its containing folder (if ordered).
    
    Specified by:
    
    getPos in interface Document
    
    Returns:
    the position
  - getParent
```
public Document getParent()
                   throws DocumentException
```
    Description copied from interface: Document
    
    Gets the parent document, or null if this is the root document.
    
    Specified by:
    
    getParent in interface Document
    
    Returns:
    the parent document, or null
    
    Throws:
    
    DocumentException
  - isProxy
```
public boolean isProxy()
```
    Description copied from interface: Document
    
    Checks whether or not this document is a proxy.
    
    Specified by:
    
    isProxy in interface Document
    
    Returns:
    true if this document is a proxy, false otherwise
  - isVersion
```
public boolean isVersion()
```
    Description copied from interface: Document
    
    Checks whether this document is a version document.
    
    Specified by:
    
    isVersion in interface Document
    
    Returns:
    true if it's a version, false otherwise
  - getPath
```
public String getPath()
               throws DocumentException
```
    Description copied from interface: Document
    
    Gets the path of this document.
    
    Specified by:
    
    getPath in interface Document
    
    Returns:
    the path
    
    Throws:
    
    DocumentException
  - getChild
```
public Document getChild(String name)
                  throws DocumentException
```
    Description copied from interface: Document
    
    Gets a child document given its name.
    Throws NoSuchDocumentException if the document could not be found.
    
    Specified by:
    
    getChild in interface Document
    
    Parameters:
    name - the name of the child to retrieve
    
    Returns:
    the child if exists
    
    Throws:
    
    NoSuchDocumentException - if the child does not exist
    
    DocumentException
  - getChildren
```
public Iterator<Document> getChildren()
                               throws DocumentException
```
    Description copied from interface: Document
    
    Gets an iterator over the children of the document.
    Returns an empty iterator for non-folder documents.
    
    Specified by:
    
    getChildren in interface Document
    
    Returns:
    the children iterator
    
    Throws:
    
    DocumentException
  - getChildrenIds
```
public List<String> getChildrenIds()
                            throws DocumentException
```
    Description copied from interface: Document
    
    Gets a list of the children ids.
    Returns an empty list for non-folder documents.
    
    Specified by:
    
    getChildrenIds in interface Document
    
    Returns:
    a list of children ids.
    
    Throws:
    
    DocumentException
  - hasChild
```
public boolean hasChild(String name)
                 throws DocumentException
```
    Description copied from interface: Document
    
    Checks whether this document has a child of the given name.
    Returns false for non-folder documents.
    
    Specified by:
    
    hasChild in interface Document
    
    Parameters:
    name - the name of the child to check
    
    Returns:
    true if the child exists, false otherwise
    
    Throws:
    
    DocumentException
  - hasChildren
```
public boolean hasChildren()
                    throws DocumentException
```
    Description copied from interface: Document
    
    Tests if the document has any children.
    Returns false for non-folder documents.
    
    Specified by:
    
    hasChildren in interface Document
    
    Returns:
    true if the document has children, false otherwise
    
    Throws:
    
    DocumentException
  - addChild
```
public Document addChild(String name,
                String typeName)
                  throws DocumentException
```
    Description copied from interface: Document
    
    Creates a new child document of the given type.
    Throws an error if this document is not a folder.
    
    Specified by:
    
    addChild in interface Document
    
    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
```
public void orderBefore(String src,
               String dest)
                 throws DocumentException
```
    Description copied from interface: Document
    
    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.
    
    Specified by:
    
    orderBefore in interface Document
    
    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
  - getPropertyValue
```
public Serializable getPropertyValue(String name)
                              throws DocumentException
```
    Description copied from interface: Document
    
    Gets a property value.
    
    Specified by:
    
    getPropertyValue in interface Document
    
    Parameters:
    name - the name of the property to get
    
    Returns:
    the property value or null if the property is not set
    
    Throws:
    
    DocumentException
  - setPropertyValue
```
public void setPropertyValue(String name,
                    Serializable value)
                      throws DocumentException
```
    Description copied from interface: Document
    
    Sets a property value.
    
    Specified by:
    
    setPropertyValue in interface Document
    
    Parameters:
    name - the name of the property to set
    value - the value to set
    
    Throws:
    
    DocumentException
  - checkIn
```
public Document checkIn(String label,
               String checkinComment)
                 throws DocumentException
```
    Description copied from interface: Document
    
    Creates a new version.
    
    Specified by:
    
    checkIn in interface Document
    
    Parameters:
    label - the version label
    checkinComment - the checkin comment
    
    Returns:
    the created version
    
    Throws:
    
    DocumentException
  - checkOut
```
public void checkOut()
              throws DocumentException
```
    Specified by:
    
    checkOut in interface Document
    
    Throws:
    
    DocumentException
  - getVersionsIds
```
public List<String> getVersionsIds()
                            throws DocumentException
```
    Description copied from interface: Document
    
    Gets the list of version ids for this document.
    
    Specified by:
    
    getVersionsIds in interface Document
    
    Returns:
    the list of version ids
    
    Throws:
    
    DocumentException
  - getVersions
```
public List<Document> getVersions()
                           throws DocumentException
```
    Description copied from interface: Document
    
    Gets the versions for this document.
    
    Specified by:
    
    getVersions in interface Document
    
    Returns:
    the versions of the document, or an empty list if there are no versions
    
    Throws:
    
    DocumentException
  - getLastVersion
```
public Document getLastVersion()
                        throws DocumentException
```
    Description copied from interface: Document
    
    Gets the last version of this document.
    Returns null if there is no version at all.
    
    Specified by:
    
    getLastVersion in interface Document
    
    Returns:
    the last version, or null if there is no version
    
    Throws:
    
    DocumentException
  - getSourceDocument
```
public Document getSourceDocument()
                           throws DocumentException
```
    Description copied from interface: Document
    
    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.
    
    Specified by:
    
    getSourceDocument in interface Document
    
    Returns:
    the source document
    
    Throws:
    
    DocumentException
  - restore
```
public void restore(Document version)
             throws DocumentException
```
    Description copied from interface: Document
    
    Replaces this document's content with the version specified.
    
    Specified by:
    
    restore in interface Document
    
    Parameters:
    version - the version to replace with
    
    Throws:
    
    DocumentException
  - getVersion
```
public Document getVersion(String label)
                    throws DocumentException
```
    Description copied from interface: Document
    
    Gets a version of this document, given its label.
    
    Specified by:
    
    getVersion in interface Document
    
    Parameters:
    label - the version label
    
    Returns:
    the version
    
    Throws:
    
    DocumentException
  - getBaseVersion
```
public Document getBaseVersion()
                        throws DocumentException
```
    Description copied from interface: Document
    
    Gets the version to which a checked in document is linked.
    Returns null for a checked out document or a version or a proxy.
    
    Specified by:
    
    getBaseVersion in interface Document
    
    Returns:
    the version, or null
    
    Throws:
    
    DocumentException
  - isCheckedOut
```
public boolean isCheckedOut()
                     throws DocumentException
```
    Description copied from interface: Document
    
    Checks whether this document is checked out.
    
    Specified by:
    
    isCheckedOut in interface Document
    
    Returns:
    true if the document is checked out, or false otherwise
    
    Throws:
    
    DocumentException
  - getVersionSeriesId
```
public String getVersionSeriesId()
                          throws DocumentException
```
    Description copied from interface: Document
    
    Gets the version series id.
    
    Specified by:
    
    getVersionSeriesId in interface Document
    
    Returns:
    the version series id
    
    Throws:
    
    DocumentException
  - getVersionCreationDate
```
public Calendar getVersionCreationDate()
                                throws DocumentException
```
    Description copied from interface: Document
    
    Gets the version creation date of this document if it's a version or a proxy.
    
    Specified by:
    
    getVersionCreationDate in interface Document
    
    Returns:
    the version creation date, or null if it's not a version or a proxy
    
    Throws:
    
    DocumentException
  - getVersionLabel
```
public String getVersionLabel()
                       throws DocumentException
```
    Description copied from interface: Document
    
    Gets the version label.
    
    Specified by:
    
    getVersionLabel in interface Document
    
    Returns:
    the version label
    
    Throws:
    
    DocumentException
  - getCheckinComment
```
public String getCheckinComment()
                         throws DocumentException
```
    Description copied from interface: Document
    
    Gets the version check in comment of this document if it's a version or a proxy.
    
    Specified by:
    
    getCheckinComment in interface Document
    
    Returns:
    the check in comment, or null if it's not a version or a proxy
    
    Throws:
    
    DocumentException
  - isLatestVersion
```
public boolean isLatestVersion()
                        throws DocumentException
```
    Description copied from interface: Document
    
    Checks whether this document is the latest version.
    
    Specified by:
    
    isLatestVersion in interface Document
    
    Returns:
    true if this is the latest version, or false otherwise
    
    Throws:
    
    DocumentException
  - isMajorVersion
```
public boolean isMajorVersion()
                       throws DocumentException
```
    Description copied from interface: Document
    
    Checks whether this document is a major version.
    
    Specified by:
    
    isMajorVersion in interface Document
    
    Returns:
    true if this is a major version, or false otherwise
    
    Throws:
    
    DocumentException
  - isLatestMajorVersion
```
public boolean isLatestMajorVersion()
                             throws DocumentException
```
    Description copied from interface: Document
    
    Checks whether this document is the latest major version.
    
    Specified by:
    
    isLatestMajorVersion in interface Document
    
    Returns:
    true if this is the latest major version, or false otherwise
    
    Throws:
    
    DocumentException
  - isVersionSeriesCheckedOut
```
public boolean isVersionSeriesCheckedOut()
                                  throws DocumentException
```
    Description copied from interface: Document
    
    Checks if there is a checked out working copy for the version series of this document.
    
    Specified by:
    
    isVersionSeriesCheckedOut in interface Document
    
    Returns:
    true if there is a checked out working copy
    
    Throws:
    
    DocumentException
  - getWorkingCopy
```
public Document getWorkingCopy()
                        throws DocumentException
```
    Description copied from interface: Document
    
    Gets the working copy for this document.
    
    Specified by:
    
    getWorkingCopy in interface Document
    
    Returns:
    the working copy
    
    Throws:
    
    DocumentException
  - setLock
```
public Lock setLock(Lock lock)
             throws DocumentException
```
    Description copied from interface: Document
    
    Sets a lock on this document.
    
    Specified by:
    
    setLock in interface Document
    
    Parameters:
    lock - the lock to set
    
    Returns:
    null if locking succeeded, or the existing lock if locking failed
    
    Throws:
    
    DocumentException
  - removeLock
```
public Lock removeLock(String owner)
                throws DocumentException
```
    Description copied from interface: Document
    
    Removes a lock from this document.
    
    Specified by:
    
    removeLock in interface Document
    
    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
```
public Lock getLock()
             throws DocumentException
```
    Description copied from interface: Document
    
    Gets the lock if one set on this document.
    
    Specified by:
    
    getLock in interface Document
    
    Returns:
    the lock, or null if no lock is set
    
    Throws:
    
    DocumentException
  - isFolder
```
public boolean isFolder()
```
    Description copied from interface: Document
    
    Checks whether this document is a folder.
    
    Specified by:
    
    isFolder in interface Document
    
    Returns:
    true if the document is a folder, false otherwise
  - setReadOnly
```
public void setReadOnly(boolean readonly)
```
    Description copied from interface: Document
    
    Sets this document as readonly or not.
    
    Specified by:
    
    setReadOnly in interface Document
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: Document
    
    Checks whether this document is readonly or not.
    
    Specified by:
    
    isReadOnly in interface Document
  - remove
```
public void remove()
            throws DocumentException
```
    Description copied from interface: Document
    
    Removes this document and all its children, if any.
    
    Specified by:
    
    remove in interface Document
    
    Throws:
    
    DocumentException
  - getLifeCycleState
```
public String getLifeCycleState()
                         throws LifeCycleException
```
    Description copied from interface: Document
    
    Gets the life cycle state of this document.
    
    Specified by:
    
    getLifeCycleState in interface Document
    
    Returns:
    the life cycle state
    
    Throws:
    
    LifeCycleException
  - setCurrentLifeCycleState
```
public void setCurrentLifeCycleState(String lifeCycleState)
                              throws LifeCycleException
```
    Description copied from interface: Document
    
    Sets the life cycle state of this document.
    
    Specified by:
    
    setCurrentLifeCycleState in interface Document
    
    Parameters:
    lifeCycleState - the life cycle state
    
    Throws:
    
    LifeCycleException
  - getLifeCyclePolicy
```
public String getLifeCyclePolicy()
                          throws LifeCycleException
```
    Description copied from interface: Document
    
    Gets the life cycle policy of this document.
    
    Specified by:
    
    getLifeCyclePolicy in interface Document
    
    Returns:
    the life cycle policy
    
    Throws:
    
    LifeCycleException
  - setLifeCyclePolicy
```
public void setLifeCyclePolicy(String policy)
                        throws LifeCycleException
```
    Description copied from interface: Document
    
    Sets the life cycle policy of this document.
    
    Specified by:
    
    setLifeCyclePolicy in interface Document
    
    Parameters:
    policy - the life cycle policy
    
    Throws:
    
    LifeCycleException
  - followTransition
```
public void followTransition(String transition)
                      throws LifeCycleException
```
    Description copied from interface: Document
    
    Follows a given life cycle transition.
    This will update the life cycle state of the document.
    
    Specified by:
    
    followTransition in interface Document
    
    Parameters:
    transition - the name of the transition to follow
    
    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
    
    Throws:
    
    LifeCycleException
  - setSystemProp
```
public void setSystemProp(String name,
                 Serializable value)
                   throws DocumentException
```
    Description copied from interface: Document
    
    Sets a system property.
    
    Specified by:
    
    setSystemProp in interface Document
    
    Throws:
    
    DocumentException
  - getSystemProp
```
public <T extends Serializable> T getSystemProp(String name,
                                       Class<T> type)
                                     throws DocumentException
```
    Description copied from interface: Document
    
    Gets a system property.
    
    Specified by:
    
    getSystemProp in interface Document
    
    Throws:
    
    DocumentException
  - readDocumentPart
```
public void readDocumentPart(DocumentPart dp)
                      throws PropertyException
```
    Description copied from interface: Document
    
    Loads a DocumentPart from storage.
    Reading data is done by DocumentPart because of per-proxy schemas.
    
    Specified by:
    
    readDocumentPart in interface Document
    
    Throws:
    
    PropertyException
  - readPrefetch
```
public Map<String,Serializable> readPrefetch(ComplexType complexType,
                                    Set<String> xpaths)
                                      throws PropertyException
```
    Description copied from interface: Document
    
    Reads a set of prefetched fields.
    Reading data is done by ComplexType because of per-proxy schemas.
    
    Specified by:
    
    readPrefetch in interface Document
    
    Throws:
    
    PropertyException
  - writeDocumentPart
```
public void writeDocumentPart(DocumentPart dp)
                       throws PropertyException
```
    Description copied from interface: Document
    
    Writes a DocumentPart to storage.
    Writing data is done by DocumentPart because of per-proxy schemas.
    
    Specified by:
    
    writeDocumentPart in interface Document
    
    Throws:
    
    PropertyException
  - getAllFacets
```
public Set<String> getAllFacets()
```
    Description copied from interface: Document
    
    Gets the facets available on this document (from the type and the instance facets).
    
    Specified by:
    
    getAllFacets in interface Document
    
    Returns:
    the facets
  - getFacets
```
public String[] getFacets()
```
    Description copied from interface: Document
    
    Gets the facets defined on this document instance. The type facets are not returned.
    
    Specified by:
    
    getFacets in interface Document
    
    Returns:
    the facets
  - hasFacet
```
public boolean hasFacet(String facet)
```
    Description copied from interface: Document
    
    Checks whether this document has a given facet, either from its type or added on the instance.
    
    Specified by:
    
    hasFacet in interface Document
    
    Parameters:
    facet - the facet name
    
    Returns:
    true if the document has the facet
  - addFacet
```
public boolean addFacet(String facet)
                 throws DocumentException
```
    Description copied from interface: Document
    
    Adds a facet to this document.
    Does nothing if the facet was already present on the document.
    
    Specified by:
    
    addFacet in interface 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
  - removeFacet
```
public boolean removeFacet(String facet)
                    throws DocumentException
```
    Description copied from interface: Document
    
    Removes a facet from this document.
    It's not possible to remove a facet coming from the document type.
    
    Specified by:
    
    removeFacet in interface Document
    
    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
  - getTargetDocument
```
public Document getTargetDocument()
                           throws DocumentException
```
    Description copied from interface: Document
    
    Gets the document (version or live document) to which this proxy points.
    
    Specified by:
    
    getTargetDocument in interface Document
    
    Throws:
    
    DocumentException
  - setTargetDocument
```
public void setTargetDocument(Document target)
                       throws DocumentException
```
    Description copied from interface: Document
    
    Sets the document (version or live document) to which this proxy points.
    
    Specified by:
    
    setTargetDocument in interface Document
    
    Throws:
    
    DocumentException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DBSDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSPROP_FULLTEXT_SIMPLE

SYSPROP_FULLTEXT_BINARY

SYSPROP_FULLTEXT_JOBID

KEY_PREFIX

KEY_ID

KEY_PARENT_ID

KEY_ANCESTOR_IDS

KEY_PRIMARY_TYPE

KEY_MIXIN_TYPES

KEY_NAME

KEY_POS

KEY_ACP

KEY_ACL_NAME

KEY_PATH_INTERNAL

KEY_ACL

KEY_ACE_USER

KEY_ACE_PERMISSION

KEY_ACE_GRANT

KEY_READ_ACL

KEY_IS_CHECKED_IN

KEY_IS_VERSION

KEY_IS_LATEST_VERSION

KEY_IS_LATEST_MAJOR_VERSION

KEY_MAJOR_VERSION

KEY_MINOR_VERSION

KEY_VERSION_SERIES_ID

KEY_VERSION_CREATED

KEY_VERSION_LABEL

KEY_VERSION_DESCRIPTION

KEY_BASE_VERSION_ID

KEY_IS_PROXY

KEY_PROXY_TARGET_ID

KEY_PROXY_VERSION_SERIES_ID

KEY_PROXY_IDS

KEY_LIFECYCLE_POLICY

KEY_LIFECYCLE_STATE

KEY_LOCK_OWNER

KEY_LOCK_CREATED

KEY_BLOB_NAME

KEY_BLOB_MIME_TYPE

KEY_BLOB_ENCODING

KEY_BLOB_DIGEST

KEY_BLOB_LENGTH

KEY_BLOB_DATA

KEY_FULLTEXT_SIMPLE

KEY_FULLTEXT_BINARY

KEY_FULLTEXT_JOBID

KEY_FULLTEXT_SCORE

APPLICATION_OCTET_STREAM

Constructor Detail

DBSDocument

Method Detail

getType

getSession

getRepositoryName

getUUID

getName

getPos

getParent

isProxy

isVersion

getPath

getChild

getChildren

getChildrenIds

hasChild

hasChildren

addChild

orderBefore

getPropertyValue

setPropertyValue

checkIn

checkOut

getVersionsIds