|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.ecm.core.storage.sql.coremodel.SQLBaseProperty org.nuxeo.ecm.core.storage.sql.coremodel.SQLComplexProperty org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocumentLive
public class SQLDocumentLive
Field Summary |
---|
Fields inherited from interface org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocument |
---|
BINARY_TEXT_SYS_PROP |
Method Summary | ||
---|---|---|
Document |
addChild(java.lang.String name,
java.lang.String typeName)
Creates a new child document given its typename. |
|
Document |
checkIn(java.lang.String label,
java.lang.String checkinComment)
Creates a new version. |
|
void |
checkOut()
|
|
boolean |
equals(java.lang.Object other)
|
|
boolean |
followTransition(java.lang.String transition)
Follows a given life cycle transition. |
|
Property |
getACLProperty()
Returns the property holding the ACL. |
|
java.util.Collection<java.lang.String> |
getAllowedStateTransitions()
Returns the allowed state transitions for this document. |
|
Document |
getBaseVersion()
Gets the version to which a checked in document is linked. |
|
java.lang.String |
getCheckinComment()
|
|
Document |
getChild(java.lang.String name)
Gets a child document given its name. |
|
java.util.Iterator<Document> |
getChildren()
Gets an iterator over the children of the document. |
|
DocumentIterator |
getChildren(int start)
|
|
java.util.List<java.lang.String> |
getChildrenIds()
Gets a list of the children ids. |
|
java.util.Calendar |
getLastModified()
Gets the last modification time on this document. |
|
Document |
getLastVersion()
Gets the last version of 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 |
getLock()
Gets the lock key if a lock exists on the current object. |
|
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. |
|
Document |
getSourceDocument()
Gets the head ("live") version of this document. |
|
|
getSystemProp(java.lang.String name,
java.lang.Class<T> type)
Get system property of the specified type. |
|
DocumentType |
getType()
Gets the property type. |
|
java.lang.String |
getUUID()
Gets this document's UUID. |
|
Document |
getVersion(java.lang.String label)
Gets a version of this document, given its label. |
|
java.util.Calendar |
getVersionCreationDate()
|
|
java.lang.String |
getVersionLabel()
|
|
java.util.List<Document> |
getVersions()
|
|
java.lang.String |
getVersionSeriesId()
Gets the version series id. |
|
java.util.List<java.lang.String> |
getVersionsIds()
Gets the list of version ids for this document. |
|
Document |
getWorkingCopy()
|
|
boolean |
hasChild(java.lang.String name)
Tests if the document has the named child. |
|
boolean |
hasChildren()
Tests if the document has any children. |
|
int |
hashCode()
|
|
boolean |
hasVersions()
Tells the caller if this document has versions or not. |
|
boolean |
isCheckedOut()
|
|
boolean |
isFolder()
Tests whether this document represent a folder or a leaf document. |
|
boolean |
isLatestMajorVersion()
|
|
boolean |
isLatestVersion()
|
|
boolean |
isLocked()
Tests if the current object is locked. |
|
boolean |
isMajorVersion()
|
|
boolean |
isProxy()
Checks whether or not this doc is a proxy document. |
|
boolean |
isVersion()
Checks whether or not this doc is a version document. |
|
boolean |
isVersionSeriesCheckedOut()
|
|
void |
orderBefore(java.lang.String src,
java.lang.String dest)
Orders the given source child before the destination child. |
|
void |
readDocumentPart(DocumentPart dp)
Reads into the DocumentPart the values from this
SQLDocument . |
|
void |
remove()
Removes this document and all its children, if any. |
|
void |
removeChild(java.lang.String name)
Removes the child having the given name If this is not a folder does nothing. |
|
Document |
resolvePath(java.lang.String path)
Resolves a document given its relative path to the current document. |
|
void |
restore(Document version)
Replaces current version with version specified. |
|
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. |
|
void |
setLock(java.lang.String key)
Sets a lock on the current 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. |
|
java.lang.String |
toString()
|
|
java.lang.String |
unlock()
Removes the lock on the object if any exists, otherwise do nothing. |
|
void |
writeDocumentPart(DocumentPart dp)
Writes into this SQLDocument the values from the
DocumentPart . |
Methods inherited from class org.nuxeo.ecm.core.storage.sql.coremodel.SQLComplexProperty |
---|
exportFlatMap, exportMap, exportMap, getBoolean, getContent, getDate, getDirtyFields, getDouble, getLong, getName, getNode, getProperties, getProperty, getPropertyIterator, getPropertyValue, getString, getValue, importFlatMap, importMap, isPropertySet, removeProperty, setBoolean, setContent, setDate, setDouble, setLong, setPropertyValue, setString, setValue |
Methods inherited from class org.nuxeo.ecm.core.storage.sql.coremodel.SQLBaseProperty |
---|
checkWritable, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocument |
---|
checkWritable, getNode |
Methods inherited from interface org.nuxeo.ecm.core.model.Document |
---|
getName |
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.model.Property |
---|
getName, getProperties, getProperty, getPropertyIterator, getValue, isNull, isPropertySet, setNull, setValue |
Method Detail |
---|
public Property getACLProperty() throws DocumentException
SQLDocument
getACLProperty
in interface SQLDocument
DocumentException
public DocumentType getType()
Property
getType
in interface Document
getType
in interface Property
getType
in class SQLBaseProperty
public Session getSession()
Document
getSession
in interface Document
public boolean isFolder()
Document
isFolder
in interface Document
public java.lang.String getUUID()
Document
getUUID
in interface Document
public Document getParent() throws DocumentException
Document
getParent
in interface Document
DocumentException
public java.lang.String getPath() throws DocumentException
Document
getPath
in interface Document
DocumentException
public java.util.Calendar getLastModified()
Document
getLastModified
in interface Document
public boolean isProxy()
Document
isProxy
in interface Document
public Repository getRepository()
Document
getRepository
in interface Document
public void remove() throws DocumentException
Document
remove
in interface Document
DocumentException
- if an error occurspublic void save() throws DocumentException
Document
For some implementations this may do nothing if they are commiting modifications as they are done by calling the corresponding method.
save
in interface Document
DocumentException
- if an error occurspublic void readDocumentPart(DocumentPart dp) throws java.lang.Exception
DocumentPart
the values from this
SQLDocument
.
readDocumentPart
in interface Document
java.lang.Exception
public void writeDocumentPart(DocumentPart dp) throws java.lang.Exception
SQLDocument
the values from the
DocumentPart
.
writeDocumentPart
in interface Document
java.lang.Exception
public <T extends java.io.Serializable> void setSystemProp(java.lang.String name, T value) throws DocumentException
Document
setSystemProp
in interface Document
DocumentException
public <T extends java.io.Serializable> T getSystemProp(java.lang.String name, java.lang.Class<T> type) throws DocumentException
Document
getSystemProp
in interface Document
DocumentException
public java.lang.String getLifeCyclePolicy() throws LifeCycleException
Document
getLifeCyclePolicy
in interface Document
LifeCycleException
public void setLifeCyclePolicy(java.lang.String policy) throws LifeCycleException
Document
setLifeCyclePolicy
in interface Document
policy
- the policy
LifeCycleException
public java.lang.String getLifeCycleState() throws LifeCycleException
Document
getLifeCycleState
in interface Document
LifeCycleException
org.nuxeo.ecm.core.lifecycle
public void setCurrentLifeCycleState(java.lang.String state) throws LifeCycleException
Document
setCurrentLifeCycleState
in interface Document
state
- the state
LifeCycleException
public boolean followTransition(java.lang.String transition) throws LifeCycleException
Document
This will update the current life cycle of the document.
followTransition
in interface Document
transition
- the name of the transition to follow
LifeCycleException
public java.util.Collection<java.lang.String> getAllowedStateTransitions() throws LifeCycleException
Document
getAllowedStateTransitions
in interface Document
LifeCycleException
public boolean isLocked() throws DocumentException
Lockable
isLocked
in interface Lockable
DocumentException
public java.lang.String getLock() throws DocumentException
Lockable
getLock
in interface Lockable
DocumentException
public void setLock(java.lang.String key) throws DocumentException
Lockable
The lock key cannot be null.
setLock
in interface Lockable
key
- the lock key
DocumentException
public java.lang.String unlock() throws DocumentException
Lockable
unlock
in interface Lockable
DocumentException
public boolean isVersion()
VersionableDocument
isVersion
in interface VersionableDocument
public Document getBaseVersion() throws DocumentException
VersionableDocument
Returns null
for a checked out document or a version or a proxy.
getBaseVersion
in interface VersionableDocument
null
DocumentException
public java.lang.String getVersionSeriesId() throws DocumentException
VersionableDocument
getVersionSeriesId
in interface VersionableDocument
DocumentException
public Document getSourceDocument() throws DocumentException
VersionableDocument
getSourceDocument
in interface VersionableDocument
DocumentException
public Document checkIn(java.lang.String label, java.lang.String checkinComment) throws DocumentException
VersionableDocument
checkIn
in interface VersionableDocument
label
- the version labelcheckinComment
- the checkin comment
DocumentException
public void checkOut() throws DocumentException
checkOut
in interface VersionableDocument
DocumentException
public boolean isCheckedOut() throws DocumentException
isCheckedOut
in interface VersionableDocument
DocumentException
public boolean isMajorVersion() throws DocumentException
isMajorVersion
in interface VersionableDocument
DocumentException
public boolean isLatestVersion() throws DocumentException
isLatestVersion
in interface VersionableDocument
DocumentException
public boolean isLatestMajorVersion() throws DocumentException
isLatestMajorVersion
in interface VersionableDocument
DocumentException
public boolean isVersionSeriesCheckedOut() throws DocumentException
isVersionSeriesCheckedOut
in interface VersionableDocument
DocumentException
public java.lang.String getVersionLabel() throws DocumentException
getVersionLabel
in interface VersionableDocument
DocumentException
public java.lang.String getCheckinComment() throws DocumentException
getCheckinComment
in interface VersionableDocument
DocumentException
public Document getWorkingCopy() throws DocumentException
getWorkingCopy
in interface VersionableDocument
DocumentException
public java.util.Calendar getVersionCreationDate() throws DocumentException
getVersionCreationDate
in interface VersionableDocument
DocumentException
public void restore(Document version) throws DocumentException
VersionableDocument
restore
in interface VersionableDocument
version
- the version to replace with
DocumentException
public java.util.List<java.lang.String> getVersionsIds() throws DocumentException
VersionableDocument
getVersionsIds
in interface VersionableDocument
DocumentException
public Document getVersion(java.lang.String label) throws DocumentException
VersionableDocument
getVersion
in interface VersionableDocument
label
- the version label
DocumentException
public java.util.List<Document> getVersions() throws DocumentException
getVersions
in interface VersionableDocument
DocumentException
public Document getLastVersion() throws DocumentException
VersionableDocument
getLastVersion
in interface VersionableDocument
DocumentException
public boolean hasVersions() throws DocumentException
VersionableDocument
Needed to know if we need to use checkin/checkout methods when changing a document.
hasVersions
in interface VersionableDocument
DocumentException
public Document resolvePath(java.lang.String path) throws DocumentException
DocumentContainer
If the path is absolute then it will be transformed in a relative path (i.e. the leading '/' removed).
resolvePath
in interface DocumentContainer
path
- the path relative to this document
DocumentException
public Document getChild(java.lang.String name) throws DocumentException
DocumentContainer
Throws an exception if the document could not be found.
If the supplied name is null, returns the default child of the document if any, otherwise raises an exception.
getChild
in interface DocumentContainer
name
- the name of the child to retrieve
DocumentException
public java.util.Iterator<Document> getChildren() throws DocumentException
DocumentContainer
This operation silently ignores non-folder documents: if the document is not a folder then it returns an empty iterator.
getChildren
in interface DocumentContainer
DocumentException
public DocumentIterator getChildren(int start) throws DocumentException
getChildren
in interface DocumentContainer
DocumentException
public java.util.List<java.lang.String> getChildrenIds() throws DocumentException
DocumentContainer
getChildrenIds
in interface DocumentContainer
DocumentException
public boolean hasChild(java.lang.String name) throws DocumentException
DocumentContainer
This operation silently ignores non-folder documents: If the document is not a folder then return false.
hasChild
in interface DocumentContainer
name
- the name of the child to test
DocumentException
public boolean hasChildren() throws DocumentException
DocumentContainer
This operation silently ignores non-folder documents: If the document is not a folder then returns false.
hasChildren
in interface DocumentContainer
DocumentException
public Document addChild(java.lang.String name, java.lang.String typeName) throws DocumentException
DocumentContainer
This operation throws an error if the current document is not a folder.
addChild
in interface DocumentContainer
name
- the name of the new child to createtypeName
- the type of the child to create
DocumentException
public void orderBefore(java.lang.String src, java.lang.String dest) throws DocumentException
DocumentContainer
orderBefore
in interface DocumentContainer
src
- the document to movedest
- the document before which to place the source document
DocumentException
- if this document is not an orderable folder or any other exception occurspublic void removeChild(java.lang.String name) throws DocumentException
DocumentContainer
If this is not a folder does nothing.
If this is a folder and no child exists with the given name then throws an exception
removeChild
in interface DocumentContainer
name
- the child name
DocumentException
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |