Uses of Interface
org.nuxeo.ecm.core.model.Document

Packages that use Document

Package	Description
org.nuxeo.ecm.core.api	The core API of the Nuxeo platform, including: CoreSession, DocumentModel, Blob.
org.nuxeo.ecm.core.lifecycle	LifeCycle API.
org.nuxeo.ecm.core.lifecycle.impl	Implementation of the LifeCycle API.
org.nuxeo.ecm.core.model
org.nuxeo.ecm.core.security
org.nuxeo.ecm.core.storage.dbs
org.nuxeo.ecm.core.storage.sql.coremodel
org.nuxeo.ecm.core.storage.sql.security
org.nuxeo.ecm.core.versioning

Uses of Document in org.nuxeo.ecm.core.api

Methods in org.nuxeo.ecm.core.api with parameters of type Document

Modifier and Type	Method and Description
static DataModel	DocumentModelFactory.createDataModel(Document doc, Schema schema) Creates a data model from a document and a schema.
static DocumentModelImpl	DocumentModelFactory.createDocumentModel(Document doc)
static DocumentModelImpl	DocumentModelFactory.createDocumentModel(Document doc, String[] schemas) Creates a document model for an existing document.
static DocumentModel.DocumentModelRefresh	DocumentModelFactory.refreshDocumentModel(Document doc, int flags, String[] schemas) Gets what's to refresh in a model (except for the ACPs, which need the session).
static DocumentModel	DocumentModelFactory.writeDocumentModel(DocumentModel docModel, Document doc) Writes a document model to a document.

Uses of Document in org.nuxeo.ecm.core.lifecycle

Methods in org.nuxeo.ecm.core.lifecycle with parameters of type Document

Modifier and Type	Method and Description
void	LifeCycleService.followTransition(Document doc, String transitionName) Follows a given transition.
LifeCycle	LifeCycleService.getLifeCycleFor(Document doc) Returns the life cycle a given document follows.
void	LifeCycleService.initialize(Document doc) Initializes the life cycle for the given document.
void	LifeCycleService.initialize(Document doc, String initialStateName) Initializes the life cycle for the given document.
void	LifeCycleService.reinitLifeCycle(Document doc) Sets the current state to the initial state as defined by the associated lifecycle.

Uses of Document in org.nuxeo.ecm.core.lifecycle.impl

Methods in org.nuxeo.ecm.core.lifecycle.impl with parameters of type Document

Modifier and Type	Method and Description
void	LifeCycleServiceImpl.followTransition(Document doc, String transitionName)
LifeCycle	LifeCycleServiceImpl.getLifeCycleFor(Document doc)
void	LifeCycleServiceImpl.initialize(Document doc)
void	LifeCycleServiceImpl.initialize(Document doc, String initialStateName)
void	LifeCycleServiceImpl.reinitLifeCycle(Document doc)

Uses of Document in org.nuxeo.ecm.core.model

Classes in org.nuxeo.ecm.core.model that implement Document

Modifier and Type	Class and Description
class	MockDocument

Methods in org.nuxeo.ecm.core.model that return Document

Modifier and Type	Method and Description
Document	MockDocument.addChild(String name, String typeName)
Document	Document.addChild(String name, String typeName) Creates a new child document of the given type.
Document	MockDocument.checkIn(String label, String description)
Document	Document.checkIn(String label, String checkinComment) Creates a new version.
Document	Session.copy(Document src, Document dst, String name) Copies the source document to the given folder.
Document	Session.createProxy(Document doc, Document folder) Creates a generic proxy to the given document inside the given folder.
Document	MockDocument.getBaseVersion()
Document	Document.getBaseVersion() Gets the version to which a checked in document is linked.
Document	MockDocument.getChild(String name)
Document	Document.getChild(String name) Gets a child document given its name.
Document	Session.getDocumentByUUID(String uuid) Gets a document given its ID.
Document	MockDocument.getLastVersion()
Document	Document.getLastVersion() Gets the last version of this document.
Document	Session.getNullDocument() Gets the null document, to be used as a fake parent to add placeless children.
Document	MockDocument.getParent()
Document	Document.getParent() Gets the parent document, or null if this is the root document.
Document	Session.getRootDocument() Gets the root document in this repository.
Document	MockDocument.getSourceDocument()
Document	Document.getSourceDocument() Gets the source for this document.
Document	MockDocument.getTargetDocument()
Document	Document.getTargetDocument() Gets the document (version or live document) to which this proxy points.
Document	MockDocument.getVersion(String label)
Document	Document.getVersion(String label) Gets a version of this document, given its label.
Document	Session.getVersion(String versionableId, VersionModel versionModel) Gets a version of a document, given its versionable id and label.
Document	MockDocument.getWorkingCopy()
Document	Document.getWorkingCopy() Gets the working copy for this document.
Document	Session.importDocument(String uuid, Document parent, String name, String typeName, Map<String,Serializable> properties) Imports a document with a given id and parent.
Document	Session.move(Document src, Document dst, String name) Moves the source document to the given folder.
Document	EmptyDocumentIterator.next()
Document	Session.resolvePath(String path) Gets the document at the given path, if any.

Methods in org.nuxeo.ecm.core.model that return types with arguments of type Document

Modifier and Type	Method and Description
Iterator<Document>	MockDocument.getChildren()
Iterator<Document>	Document.getChildren() Gets an iterator over the children of the document.
Collection<Document>	Session.getProxies(Document doc, Document folder) Finds the proxies for a document.
List<Document>	MockDocument.getVersions()
List<Document>	Document.getVersions() Gets the versions for this document.

Methods in org.nuxeo.ecm.core.model with parameters of type Document

Modifier and Type	Method and Description
int	PathComparator.compare(Document o1, Document o2)
Document	Session.copy(Document src, Document dst, String name) Copies the source document to the given folder.
Document	Session.createProxy(Document doc, Document folder) Creates a generic proxy to the given document inside the given folder.
ACP	Session.getMergedACP(Document doc)
Collection<Document>	Session.getProxies(Document doc, Document folder) Finds the proxies for a document.
Document	Session.importDocument(String uuid, Document parent, String name, String typeName, Map<String,Serializable> properties) Imports a document with a given id and parent.
Document	Session.move(Document src, Document dst, String name) Moves the source document to the given folder.
void	MockDocument.restore(Document version)
void	Document.restore(Document version) Replaces this document's content with the version specified.
void	Session.setACP(Document doc, ACP acp, boolean overwrite)
void	Session.setProxyTarget(Document proxy, Document target) Sets a proxies' target.
void	MockDocument.setTargetDocument(Document target)
void	Document.setTargetDocument(Document target) Sets the document (version or live document) to which this proxy points.

Uses of Document in org.nuxeo.ecm.core.security

Methods in org.nuxeo.ecm.core.security with parameters of type Document

Modifier and Type	Method and Description
Access	SecurityPolicyServiceImpl.checkPermission(Document doc, ACP mergedAcp, Principal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals)
Access	SecurityPolicyService.checkPermission(Document doc, ACP mergedAcp, Principal principal, String permission, String[] resolvedPermissions, String[] principalsToCheck) Checks given permission for doc and principal.
Access	SecurityPolicy.checkPermission(Document doc, ACP mergedAcp, Principal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) Checks given permission for doc and principal.
Access	LockSecurityPolicy.checkPermission(Document doc, ACP mergedAcp, Principal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals)
Access	CheckInSecurityPolicy.checkPermission(Document doc, ACP mergedAcp, Principal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals)
boolean	SecurityService.checkPermission(Document doc, Principal principal, String permission)

Uses of Document in org.nuxeo.ecm.core.storage.dbs

Classes in org.nuxeo.ecm.core.storage.dbs that implement Document

Modifier and Type	Class and Description
class	DBSDocument Implementation of a Document for Document-Based Storage.

Methods in org.nuxeo.ecm.core.storage.dbs that return Document

Modifier and Type	Method and Description
Document	DBSDocument.addChild(String name, String typeName)
Document	DBSDocument.checkIn(String label, String checkinComment)
Document	DBSSession.copy(Document source, Document parent, String name)
Document	DBSSession.createChild(String id, String parentId, String name, Long pos, String typeName)
Document	DBSSession.createProxy(Document doc, Document folder)
Document	DBSDocument.getBaseVersion()
Document	DBSDocument.getChild(String name)
Document	DBSSession.getDocumentByUUID(String id)
Document	DBSDocument.getLastVersion()
Document	DBSSession.getNullDocument()
Document	DBSDocument.getParent()
Document	DBSSession.getRootDocument()
Document	DBSDocument.getSourceDocument()
Document	DBSDocument.getTargetDocument()
Document	DBSDocument.getVersion(String label)
Document	DBSSession.getVersion(String versionSeriesId, VersionModel versionModel)
Document	DBSDocument.getWorkingCopy()
Document	DBSSession.importDocument(String id, Document parent, String name, String typeName, Map<String,Serializable> properties)
Document	DBSSession.move(Document source, Document parent, String name)
Document	DBSSession.DBSDocumentListIterator.next()
Document	DBSSession.resolvePath(String path)

Methods in org.nuxeo.ecm.core.storage.dbs that return types with arguments of type Document

Modifier and Type	Method and Description
Iterator<Document>	DBSDocument.getChildren()
Collection<Document>	DBSSession.getProxies(Document doc, Document folder)
List<Document>	DBSDocument.getVersions()

Methods in org.nuxeo.ecm.core.storage.dbs with parameters of type Document

Modifier and Type	Method and Description
Document	DBSSession.copy(Document source, Document parent, String name)
Document	DBSSession.createProxy(Document doc, Document folder)
ACP	DBSSession.getMergedACP(Document doc)
Collection<Document>	DBSSession.getProxies(Document doc, Document folder)
Document	DBSSession.importDocument(String id, Document parent, String name, String typeName, Map<String,Serializable> properties)
Document	DBSSession.move(Document source, Document parent, String name)
void	DBSDocument.restore(Document version)
void	DBSSession.setACP(Document doc, ACP acp, boolean overwrite)
void	DBSSession.setProxyTarget(Document proxy, Document target)
void	DBSDocument.setTargetDocument(Document target)

Constructor parameters in org.nuxeo.ecm.core.storage.dbs with type arguments of type Document

Constructor and Description
DBSSession.DBSDocumentListIterator(List<Document> list)

Uses of Document in org.nuxeo.ecm.core.storage.sql.coremodel

Subinterfaces of Document in org.nuxeo.ecm.core.storage.sql.coremodel

Modifier and Type	Interface and Description
interface	SQLDocument Base interface for SQL documents.

Classes in org.nuxeo.ecm.core.storage.sql.coremodel that implement Document

Modifier and Type	Class and Description
class	SQLDocumentLive
class	SQLDocumentProxy A proxy is a shortcut to a target document (a version or normal document).
class	SQLDocumentVersion

Methods in org.nuxeo.ecm.core.storage.sql.coremodel that return Document

Modifier and Type	Method and Description
Document	SQLDocumentVersion.addChild(String name, String typeName)
Document	SQLDocumentProxy.addChild(String name, String typeName)
Document	SQLDocumentLive.addChild(String name, String typeName)
Document	SQLDocumentVersion.checkIn(String label, String description)
Document	SQLDocumentProxy.checkIn(String label, String checkinComment)
Document	SQLDocumentLive.checkIn(String label, String checkinComment)
Document	SQLSession.copy(Document source, Document parent, String name)
Document	SQLSession.createProxy(Document doc, Document folder)
Document	SQLDocumentVersion.getBaseVersion()
Document	SQLDocumentProxy.getBaseVersion()
Document	SQLDocumentLive.getBaseVersion()
Document	SQLDocumentVersion.getChild(String name)
Document	SQLDocumentProxy.getChild(String name)
Document	SQLDocumentLive.getChild(String name)
Document	SQLSession.getDocumentByUUID(String uuid)
Document	SQLDocumentProxy.getLastVersion()
Document	SQLDocumentLive.getLastVersion()
Document	SQLSession.getLastVersion(String versionSeriesId)
Document	SQLSession.getNullDocument()
Document	SQLDocumentVersion.getParent()
Document	SQLDocumentProxy.getParent()
Document	SQLDocumentLive.getParent()
Document	SQLSession.getRootDocument()
Document	SQLDocumentVersion.getSourceDocument()
Document	SQLDocumentProxy.getSourceDocument()
Document	SQLDocumentLive.getSourceDocument()
Document	SQLDocumentProxy.getTargetDocument()
Document	SQLDocumentLive.getTargetDocument()
Document	SQLDocumentVersion.getVersion(String label)
Document	SQLDocumentProxy.getVersion(String label)
Document	SQLDocumentLive.getVersion(String label)
Document	SQLSession.getVersion(String versionableId, VersionModel versionModel)
Document	SQLDocumentVersion.getWorkingCopy()
Document	SQLDocumentProxy.getWorkingCopy()
Document	SQLDocumentLive.getWorkingCopy()
Document	SQLSession.importDocument(String uuid, Document parent, String name, String typeName, Map<String,Serializable> properties)
Document	SQLSession.move(Document source, Document parent, String name)
Document	SQLSession.resolvePath(String path)

Methods in org.nuxeo.ecm.core.storage.sql.coremodel that return types with arguments of type Document

Modifier and Type	Method and Description
Iterator<Document>	SQLDocumentVersion.getChildren()
Iterator<Document>	SQLDocumentProxy.getChildren()
Iterator<Document>	SQLDocumentLive.getChildren()
Collection<Document>	SQLSession.getProxies(Document document, Document parent)
List<Document>	SQLDocumentProxy.getVersions()
List<Document>	SQLDocumentLive.getVersions()

Methods in org.nuxeo.ecm.core.storage.sql.coremodel with parameters of type Document

Modifier and Type	Method and Description
Document	SQLSession.copy(Document source, Document parent, String name)
Document	SQLSession.createProxy(Document doc, Document folder)
ACP	SQLSession.getMergedACP(Document doc)
Collection<Document>	SQLSession.getProxies(Document document, Document parent)
Document	SQLSession.importDocument(String uuid, Document parent, String name, String typeName, Map<String,Serializable> properties)
Document	SQLSession.move(Document source, Document parent, String name)
void	SQLDocumentVersion.restore(Document version)
void	SQLDocumentProxy.restore(Document version)
void	SQLDocumentLive.restore(Document version)
void	SQLSession.setACP(Document doc, ACP acp, boolean overwrite)
void	SQLSession.setProxyTarget(Document proxy, Document target)
void	SQLDocumentProxy.setTargetDocument(Document target)
void	SQLDocumentLive.setTargetDocument(Document target)

Uses of Document in org.nuxeo.ecm.core.storage.sql.security

Methods in org.nuxeo.ecm.core.storage.sql.security with parameters of type Document

Modifier and Type	Method and Description
Access	NoFileSecurityPolicy.checkPermission(Document doc, ACP mergedAcp, Principal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals)

Uses of Document in org.nuxeo.ecm.core.versioning

Methods in org.nuxeo.ecm.core.versioning that return Document

Modifier and Type	Method and Description
Document	VersioningService.doCheckIn(Document doc, VersioningOption option, String checkinComment) Applies version increment option and does a checkin.
Document	VersioningComponent.doCheckIn(Document doc, VersioningOption option, String checkinComment)
Document	StandardVersioningService.doCheckIn(Document doc, VersioningOption option, String checkinComment)
Document	CompatVersioningService.doCheckIn(Document doc, VersioningOption option, String checkinComment)
Document	VersioningService.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options) Applies versioning options after document save.
Document	VersioningComponent.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)
Document	StandardVersioningService.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)
Document	CompatVersioningService.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)

Methods in org.nuxeo.ecm.core.versioning with parameters of type Document

Modifier and Type	Method and Description
Document	VersioningService.doCheckIn(Document doc, VersioningOption option, String checkinComment) Applies version increment option and does a checkin.
Document	VersioningComponent.doCheckIn(Document doc, VersioningOption option, String checkinComment)
Document	StandardVersioningService.doCheckIn(Document doc, VersioningOption option, String checkinComment)
Document	CompatVersioningService.doCheckIn(Document doc, VersioningOption option, String checkinComment)
void	VersioningService.doCheckOut(Document doc) Apply modifications after doing a checkout.
void	VersioningComponent.doCheckOut(Document doc)
void	StandardVersioningService.doCheckOut(Document doc)
void	CompatVersioningService.doCheckOut(Document doc)
void	VersioningService.doPostCreate(Document doc, Map<String,Serializable> options) Applies versioning after document creation.
void	VersioningComponent.doPostCreate(Document doc, Map<String,Serializable> options)
void	StandardVersioningService.doPostCreate(Document doc, Map<String,Serializable> options)
Document	VersioningService.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options) Applies versioning options after document save.
Document	VersioningComponent.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)
Document	StandardVersioningService.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)
Document	CompatVersioningService.doPostSave(Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)
VersioningOption	VersioningService.doPreSave(Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String,Serializable> options) Applies versioning options before document save.
VersioningOption	VersioningComponent.doPreSave(Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String,Serializable> options)
VersioningOption	StandardVersioningService.doPreSave(Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String,Serializable> options)
VersioningOption	CompatVersioningService.doPreSave(Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String,Serializable> options)
boolean	VersioningService.isPostSaveDoingCheckIn(Document doc, VersioningOption option, Map<String,Serializable> options) Checks if VersioningService.doPostSave(org.nuxeo.ecm.core.model.Document, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkin when called with the same arguments.
boolean	VersioningComponent.isPostSaveDoingCheckIn(Document doc, VersioningOption option, Map<String,Serializable> options)
boolean	StandardVersioningService.isPostSaveDoingCheckIn(Document doc, VersioningOption option, Map<String,Serializable> options)
boolean	VersioningService.isPreSaveDoingCheckOut(Document doc, boolean isDirty, VersioningOption option, Map<String,Serializable> options) Checks if VersioningService.doPreSave(org.nuxeo.ecm.core.model.Document, boolean, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkout when called with the same arguments.
boolean	VersioningComponent.isPreSaveDoingCheckOut(Document doc, boolean isDirty, VersioningOption option, Map<String,Serializable> options)
boolean	StandardVersioningService.isPreSaveDoingCheckOut(Document doc, boolean isDirty, VersioningOption option, Map<String,Serializable> options)
boolean	CompatVersioningService.isPreSaveDoingCheckOut(Document doc, boolean isDirty, VersioningOption option, Map<String,Serializable> options)
void	VersionRemovalPolicy.removeVersions(Session session, Document doc, CoreSession coreSession) Removes the versions when a given working document is about to be removed.
void	NullVersionRemovalPolicy.removeVersions(Session session, Document doc, CoreSession coreSession)
void	DefaultVersionRemovalPolicy.removeVersions(Session session, Document doc, CoreSession coreSession)