|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Document
A document object.
Method Summary | ||
---|---|---|
boolean |
followTransition(java.lang.String transition)
Follows a given life cycle transition. |
|
java.util.Collection<java.lang.String> |
getAllowedStateTransitions()
Returns the allowed state transitions for this document. |
|
java.util.Calendar |
getLastModified()
Gets the last modification time on this document. |
|
java.lang.String |
getLifeCyclePolicy()
Returns the life cycle policy of this document. |
|
java.lang.String |
getLifeCycleState()
Returns the life cycle of the document. |
|
java.lang.String |
getName()
Gets the name of this document. |
|
Document |
getParent()
Gets the parent document or null if this is the root document. |
|
java.lang.String |
getPath()
Gets the path of this document. |
|
Repository |
getRepository()
Returns the repository in which the document lives. |
|
Session |
getSession()
Gets the session that owns this document. |
|
|
getSystemProp(java.lang.String name,
java.lang.Class<T> type)
Get system property of the specified type. |
|
DocumentType |
getType()
Gets this document's type. |
|
java.lang.String |
getUUID()
Gets this document's UUID. |
|
boolean |
isFolder()
Tests whether this document represent a folder or a leaf document. |
|
boolean |
isProxy()
Checks whether or not this doc is a proxy document. |
|
void |
readDocumentPart(DocumentPart dp)
Load document part properties from storage and fill them inside the given document part. |
|
void |
remove()
Removes this document and all its children, if any. |
|
void |
save()
Saves any modification done on this document or its children. |
|
void |
setCurrentLifeCycleState(java.lang.String state)
Sets the lifecycle state of the document. |
|
void |
setLifeCyclePolicy(java.lang.String policy)
Sets the life cycle policy of this document. |
|
|
setSystemProp(java.lang.String name,
T value)
Set a system property which is a property of by the built-in node type ECM_SYSTEM_ANY. |
|
void |
writeDocumentPart(DocumentPart dp)
Read modifications in the given document part and write them on storage. |
Methods inherited from interface org.nuxeo.ecm.core.model.DocumentContainer |
---|
addChild, getChild, getChildren, getChildren, getChildrenIds, 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, checkOut, getBaseVersion, getCheckinComment, getLastVersion, getSourceDocument, getVersion, getVersionCreationDate, getVersionLabel, getVersions, getVersionSeriesId, getVersionsIds, getWorkingCopy, hasVersions, isCheckedOut, isLatestMajorVersion, isLatestVersion, isMajorVersion, isVersion, isVersionSeriesCheckedOut, restore |
Methods inherited from interface org.nuxeo.ecm.core.model.Lockable |
---|
getLock, isLocked, setLock, unlock |
Method Detail |
---|
Session getSession()
java.lang.String getName() throws DocumentException
DocumentException
- if any exception occurredjava.lang.String getUUID()
Document getParent() throws DocumentException
DocumentException
DocumentType getType()
java.lang.String getPath() throws DocumentException
DocumentException
java.util.Calendar getLastModified() throws DocumentException
DocumentException
boolean isFolder()
void remove() throws DocumentException
DocumentException
- if an error occursvoid save() throws DocumentException
For some implementations this may do nothing if they are commiting modifications as they are done by calling the corresponding method.
DocumentException
- if an error occursjava.lang.String getLifeCycleState() throws LifeCycleException
LifeCycleException
org.nuxeo.ecm.core.lifecycle
void setCurrentLifeCycleState(java.lang.String state) throws LifeCycleException
state
- the state
LifeCycleException
java.lang.String getLifeCyclePolicy() throws LifeCycleException
LifeCycleException
void setLifeCyclePolicy(java.lang.String policy) throws LifeCycleException
policy
- the policy
LifeCycleException
boolean followTransition(java.lang.String transition) throws LifeCycleException
This will update the current life cycle of the document.
transition
- the name of the transition to follow
LifeCycleException
java.util.Collection<java.lang.String> getAllowedStateTransitions() throws LifeCycleException
LifeCycleException
boolean isProxy()
Repository getRepository()
<T extends java.io.Serializable> void setSystemProp(java.lang.String name, T value) throws DocumentException
T
- name
- value
-
DocumentException
<T extends java.io.Serializable> T getSystemProp(java.lang.String name, java.lang.Class<T> type) throws DocumentException
T
- name
- type
-
DocumentException
void readDocumentPart(DocumentPart dp) throws java.lang.Exception
dp
-
java.lang.Exception
void writeDocumentPart(DocumentPart dp) throws java.lang.Exception
dp
-
java.lang.Exception
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |