Uses of Interface
org.nuxeo.ecm.core.model.Document
Package
Description
Event Service implementation.
LifeCycle API.
Implementation of the LifeCycle API.
Implementation of a Nuxeo repository over an SQL database.
-
Uses of Document in org.nuxeo.ecm.core.api
Modifier and TypeMethodDescriptionprotected Document
AbstractSession.fillCreateOptions
(DocumentRef parentRef, String childName, Map<String, Serializable> options) protected Document
AbstractSession.getFirstParentDocumentWithFacet
(DocumentRef docRef, String facet) Returns the firstDocument
with the givenfacet
, recursively going up the parent hierarchy.protected Document
AbstractSession.resolveParentReference
(DocumentRef docRef) protected Document
AbstractSession.resolveReference
(DocumentRef docRef) Modifier and TypeMethodDescriptionprotected String
AbstractSession.canRemoveDocument
(Document doc) Deprecated.protected void
AbstractSession.checkBlockedDescendants
(Document doc) protected void
AbstractSession.checkCanRemoveDocument
(Document doc) protected final void
AbstractSession.checkPermission
(Document doc, String permission) protected void
AbstractSession.checkRetainedDescendants
(Document doc) static DataModel
DocumentModelFactory.createDataModel
(Document doc, Schema schema) Creates a data model from a document and a schema.static DocumentModelImpl
DocumentModelFactory.createDocumentModel
(Document doc, CoreSession coreSession) Creates a document model for an existing document.protected DocumentModel
AbstractSession.createProxyInternal
(Document doc, Document folder, Map<String, Serializable> options) protected VersionModel
AbstractSession.getVersionModel
(Document version) protected final boolean
AbstractSession.hasPermission
(NuxeoPrincipal principal, Document doc, String permission) protected final boolean
AbstractSession.hasPermission
(Document doc, String permission) protected void
AbstractSession.loadDataModelsForFacet
(DocumentModel docModel, Document doc, String facetName) protected DocumentModel
Gets the document model for the given core document.protected DocumentModel
AbstractSession.readModel
(Document doc, DocumentModel docModel) Gets the document model for the given core document, preserving the contextData.DocumentModelFactory.refreshDocumentModel
(Document doc, int flags, String[] schemas) Gets what's to refresh in a model (except for the ACPs, which need the session).protected void
AbstractSession.removeDocument
(Document doc) AbstractSession.removeExistingProxies
(Document doc, Document folder) Remove proxies for the same base document in the folder. doc may be a normal document or a proxy.protected void
AbstractSession.removeNotifyOneDoc
(Document doc) protected DocumentModel
AbstractSession.restoreToVersion
(Document doc, Document version, boolean skipSnapshotCreation, boolean skipCheckout) protected void
AbstractSession.setACP
(Document doc, ACP newAcp, boolean overwrite, Map<String, Serializable> options) protected DocumentModel
AbstractSession.updateExistingProxies
(Document doc, Document folder, Document target) Update the proxy for doc in the given section to point to the new target.static DocumentModel
DocumentModelFactory.writeDocumentModel
(DocumentModel docModel, Document doc) Writes a document model to a document.static DocumentModel
DocumentModelFactory.writeDocumentModel
(DocumentModel docModel, Document doc, boolean create) Writes a document model to a document.protected DocumentModel
AbstractSession.writeModel
(Document doc, DocumentModel docModel) protected DocumentModel
AbstractSession.writeModel
(Document doc, DocumentModel docModel, boolean create) -
Uses of Document in org.nuxeo.ecm.core.api.versioning
Modifier and TypeMethodDescriptionVersioningService.doCheckIn
(Document doc, VersioningOption option, String checkinComment) Applies version increment option and does a checkin.VersioningService.doPostSave
(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String, Serializable> options) Applies versioning options after document save.Modifier and TypeMethodDescriptionVersioningService.doCheckIn
(Document doc, VersioningOption option, String checkinComment) Applies version increment option and does a checkin.void
VersioningService.doCheckOut
(Document doc) Apply modifications after doing a checkout.void
VersioningService.doPostCreate
(Document doc, Map<String, Serializable> options) Applies versioning after document creation.VersioningService.doPostSave
(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String, Serializable> options) Applies versioning options after document save.VersioningService.doPreSave
(CoreSession session, Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String, Serializable> options) Applies versioning options before document save.boolean
VersioningService.isPostSaveDoingCheckIn
(Document doc, VersioningOption option, Map<String, Serializable> options) Checks ifVersioningService.doPostSave(org.nuxeo.ecm.core.api.CoreSession, 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
VersioningService.isPreSaveDoingCheckOut
(Document doc, boolean isDirty, VersioningOption option, Map<String, Serializable> options) Checks ifVersioningService.doPreSave(org.nuxeo.ecm.core.api.CoreSession, 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. -
Uses of Document in org.nuxeo.ecm.core.blob
Modifier and TypeMethodDescriptionprotected void
DefaultBlobDispatcher.checkBlob
(Document doc, Document.BlobAccessor accessor) Checks if the blob is stored in the expected blob provider to which it's supposed to be dispatched.protected void
DefaultBlobDispatcher.checkBlobCanBeDeleted
(Document doc, String xpath) protected void
DefaultBlobDispatcher.deleteBlobIfRecord
(String blobProviderId, Document doc, String xpath) void
DocumentBlobManager.freezeVersion
(Document doc) Freezes the blobs' versions on a document version when it is created via a check in.void
DocumentBlobManagerComponent.freezeVersion
(Document doc) protected void
DocumentBlobManagerComponent.freezeVersion
(Document.BlobAccessor accessor, Document doc) default ManagedBlob
DocumentBlobProvider.freezeVersion
(ManagedBlob blob, Document doc) Returns a new managed blob pointing to a fixed version of the original blob.protected ManagedBlob
BlobDispatcher.getBlobProvider
(Document doc, Blob blob, String xpath) Decides whichBlobProvider
to use to write the given blob, and whether the provider id should be added as prefix to the managed blob key.DefaultBlobDispatcher.getBlobProvider
(Document doc, Blob blob, String xpath) protected ManagedBlob
DocumentBlobManagerComponent.getMainBlob
(Document doc) protected String
DefaultBlobDispatcher.getProviderId
(Document doc, Blob blob, String blobXPath) DocumentBlobManagerComponent.getRetainableBlobs
(Document doc) protected Object
DefaultBlobDispatcher.getValue
(Document doc, Blob blob, String blobXPath, DefaultBlobDispatcher.Clause clause) default void
BlobDispatcher.notifyAfterCopy
(Document doc) Notifies the blob dispatcher that the document has been copied.void
DefaultBlobDispatcher.notifyAfterCopy
(Document doc) void
DocumentBlobManager.notifyAfterCopy
(Document doc) Notifies the blob manager that the document has been copied.void
DocumentBlobManagerComponent.notifyAfterCopy
(Document doc) default void
BlobDispatcher.notifyBeforeRemove
(Document doc) Notifies the blob dispatcher that the document is about to be removed.void
DefaultBlobDispatcher.notifyBeforeRemove
(Document doc) void
DocumentBlobManager.notifyBeforeRemove
(Document doc) Notifies the blob manager that the document is about to be removed.void
DocumentBlobManagerComponent.notifyBeforeRemove
(Document doc) void
BlobDispatcher.notifyChanges
(Document doc, Set<String> xpaths) Notifies the blob dispatcher that a set of xpaths have changed on a document.void
DefaultBlobDispatcher.notifyChanges
(Document doc, Set<String> xpaths) void
DocumentBlobManager.notifyChanges
(Document doc, Set<String> xpaths) Notifies the blob manager that a set of xpaths have changed on a document.void
DocumentBlobManagerComponent.notifyChanges
(Document doc, Set<String> xpaths) default void
BlobDispatcher.notifyMakeRecord
(Document doc) Notifies the blob dispatcher that the document was made a record.void
DefaultBlobDispatcher.notifyMakeRecord
(Document doc) void
DocumentBlobManager.notifyMakeRecord
(Document doc) Notifies the blob manager that the document was made a record.void
DocumentBlobManagerComponent.notifyMakeRecord
(Document doc) void
DocumentBlobManager.notifySetLegalHold
(Document doc, boolean hold) Notifies the blob manager that the document's legal hold status was changed.void
DocumentBlobManagerComponent.notifySetLegalHold
(Document doc, boolean hold) void
DocumentBlobManager.notifySetRetainUntil
(Document doc, Calendar retainUntil) Notifies the blob manager that the document's retention date was changed.void
DocumentBlobManagerComponent.notifySetRetainUntil
(Document doc, Calendar retainUntil) Reads aBlob
from storage.Reads aBlob
from storage.protected Blob
DocumentBlobManagerComponent.readBlob
(BlobInfo blobInfo, Document doc, String xpath, String repositoryName) void
DocumentBlobManagerComponent.updateBlob
(Document doc, Consumer<BlobUpdateContext> contextFiller) Update main blob of the doc.protected void
DocumentBlobManagerComponent.updateRetainedBlobs
(Document doc, Consumer<BlobUpdateContext> contextFiller) Writes aBlob
to storage and returns its key.Writes aBlob
to storage and returns its key.ModifierConstructorDescriptionBlobContext
(Blob blob, Document doc, String xpath) BlobContext
(Document doc, String xpath) BlobInfoContext
(BlobInfo blobInfo, Document doc, String xpath) -
Uses of Document in org.nuxeo.ecm.core.event.impl
-
Uses of Document in org.nuxeo.ecm.core.lifecycle
Modifier and TypeMethodDescriptionvoid
LifeCycleService.followTransition
(Document doc, String transitionName) Follows a given transition.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
Modifier and TypeMethodDescriptionvoid
LifeCycleServiceImpl.followTransition
(Document doc, String transitionName) 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
Modifier and TypeMethodDescriptionCreates a new child document of the given type.Creates a new version.Copies the source document to the given folder.Session.createProxy
(Document doc, Document folder) Creates a generic proxy to the given document inside the given folder.Document.getBaseVersion()
Gets the version to which a checked in document is linked.Gets a child document given its name.Session.getDocumentByUUID
(String uuid) Gets a document given its ID.Document.getLastVersion()
Gets the last version of this document.Session.getNullDocument()
Gets the null document, to be used as a fake parent to add placeless children.Document.getParent()
Gets the parent document, ornull
if this is the root document.Session.getRootDocument()
Gets the root document in this repository.Document.getSourceDocument()
Gets the source for this document.Document.getTargetDocument()
Gets the document (version or live document) to which this proxy points.Document.getVersion
(String label) Gets a version of this document, given its label.Session.getVersion
(String versionableId, VersionModel versionModel) Gets a version of a document, given its versionable id and label.Document.getWorkingCopy()
Gets the working copy for this document.Session.importDocument
(String uuid, Document parent, String name, String typeName, Map<String, Serializable> properties) Imports a document with a given id and parent.Moves the source document to the given folder.Session.resolvePath
(String path) Gets the document at the given path, if any.Modifier and TypeMethodDescriptionDocument.getChildren()
Gets the children of the document.Session.getProxies
(Document doc) Finds the proxies for a document.Session.getProxies
(Document doc, Document folder) Finds the proxies for a document.Document.getVersions()
Gets the versions for this document.Does a query.Modifier and TypeMethodDescriptionint
Copies the source document to the given folder.Session.createProxy
(Document doc, Document folder) Creates a generic proxy to the given document inside the given folder.void
Flushes recorded write operations.abstract ACP
Gets the ACP for the document (without any inheritance).protected ACP
BaseSession.getMergedACP
(Document doc) Session.getMergedACP
(Document doc) Session.getProxies
(Document doc) Finds the proxies for a document.Session.getProxies
(Document doc, Document folder) Finds the proxies for a document.Session.importDocument
(String uuid, Document parent, String name, String typeName, Map<String, Serializable> properties) Imports a document with a given id and parent.Moves the source document to the given folder.protected void
BaseSession.notifyAfterCopy
(Document doc) void
Replaces this document's content with the version specified.void
void
Session.setProxyTarget
(Document proxy, Document target) Sets a proxies' 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
Modifier and TypeMethodDescriptionCheckInSecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) LockSecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) RetentionAndHoldSecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) SecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) Checks given permission for doc and principal.SecurityPolicyService.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] principalsToCheck) Checks given permission for doc and principal.SecurityPolicyServiceImpl.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) boolean
SecurityService.checkPermission
(Document doc, NuxeoPrincipal principal, String permission) SecurityService.filterGrantedPermissions
(Document doc, NuxeoPrincipal principal, Collection<String> permissions) Filters the supplied permissions based on whether they are granted to a given principal for a given document. -
Uses of Document in org.nuxeo.ecm.core.storage
Modifier and TypeClassDescriptionclass
BaseDocument<T extends StateAccessor>
Base implementation for a Document. -
Uses of Document in org.nuxeo.ecm.core.storage.dbs
Modifier and TypeMethodDescriptionprotected Document
DBSSession.createProxy
(Document doc, Document folder) DBSDocument.getBaseVersion()
protected Document
DBSSession.getDocumentByUUID
(String id) DBSDocument.getLastVersion()
protected Document
DBSSession.getLastVersion
(String versionSeriesId) DBSSession.getNullDocument()
DBSDocument.getParent()
DBSSession.getRootDocument()
DBSDocument.getSourceDocument()
DBSDocument.getVersion
(String label) DBSSession.getVersion
(String versionSeriesId, VersionModel versionModel) DBSDocument.getWorkingCopy()
DBSSession.importDocument
(String id, Document parent, String name, String typeName, Map<String, Serializable> properties) DBSSession.resolvePath
(String path) Modifier and TypeMethodDescriptionDBSDocument.getChildren()
DBSSession.getChildren
(String parentId) DBSSession.getDocuments
(List<String> ids) DBSSession.getProxies
(Document doc) DBSSession.getProxies
(Document doc, Document folder) DBSDocument.getVersions()
DBSSession.query
(String query, String queryType, QueryFilter queryFilter, long countUpTo) Modifier and TypeMethodDescriptionDBSSession.createProxy
(Document doc, Document folder) protected String
DBSSession.findFreeName
(Document parent, String name) DBSSession.getProxies
(Document doc) DBSSession.getProxies
(Document doc, Document folder) DBSSession.importDocument
(String id, Document parent, String name, String typeName, Map<String, Serializable> properties) void
protected void
DBSSession.restoreVersion
(Document doc, Document version) void
void
DBSSession.setProxyTarget
(Document proxy, Document target) void
DBSDocument.setTargetDocument
(Document target) -
Uses of Document in org.nuxeo.ecm.core.storage.sql
Modifier and TypeMethodDescriptionSession.getBinaryFulltext
(Serializable id, Document doc) Gets the fulltext extracted from the binary fields.SessionImpl.getBinaryFulltext
(Serializable id, Document doc) -
Uses of Document in org.nuxeo.ecm.core.storage.sql.coremodel
Modifier and TypeClassDescriptionclass
class
A proxy is a shortcut to a target document (a version or normal document).class
Modifier and TypeMethodDescriptionprotected Document
protected Document
SQLSession.createProxy
(Document doc, Document folder) SQLDocumentLive.getBaseVersion()
SQLDocumentProxy.getBaseVersion()
SQLDocumentVersion.getBaseVersion()
protected Document
protected Document
SQLSession.getDocumentById
(Serializable id) SQLSession.getDocumentByUUID
(String uuid) SQLDocumentLive.getLastVersion()
SQLDocumentProxy.getLastVersion()
SQLSession.getLastVersion
(String versionSeriesId) SQLSession.getNullDocument()
SQLDocumentLive.getParent()
SQLDocumentProxy.getParent()
SQLDocumentVersion.getParent()
protected Document
SQLSession.getRootDocument()
SQLDocumentLive.getSourceDocument()
SQLDocumentProxy.getSourceDocument()
SQLDocumentVersion.getSourceDocument()
SQLDocumentLive.getTargetDocument()
SQLDocumentProxy.getTargetDocument()
SQLDocumentLive.getVersion
(String label) SQLDocumentProxy.getVersion
(String label) SQLDocumentVersion.getVersion
(String label) SQLSession.getVersion
(String versionableId, VersionModel versionModel) protected Document
SQLSession.getVersionByLabel
(String versionSeriesId, String label) SQLDocumentLive.getWorkingCopy()
SQLDocumentProxy.getWorkingCopy()
SQLDocumentVersion.getWorkingCopy()
protected Document
SQLSession.importChild
(String uuid, Node parent, String name, Long pos, String typeName, Map<String, Serializable> props) SQLSession.importDocument
(String uuid, Document parent, String name, String typeName, Map<String, Serializable> properties) SQLSession.resolvePath
(String path) Modifier and TypeMethodDescriptionSQLDocumentLive.getChildren()
SQLDocumentProxy.getChildren()
SQLSession.getChildren
(Node node) SQLSession.getDocumentsById
(List<Serializable> ids) SQLSession.getProxies
(Document doc) SQLSession.getProxies
(Document document, Document parent) SQLDocumentLive.getVersions()
SQLDocumentProxy.getVersions()
SQLSession.getVersions
(String versionSeriesId) SQLSession.query
(String query, String queryType, QueryFilter queryFilter, long countUpTo) Modifier and TypeMethodDescriptionint
SQLSession.createProxy
(Document doc, Document folder) SQLSession.getProxies
(Document doc) SQLSession.getProxies
(Document document, Document parent) SQLSession.importDocument
(String uuid, Document parent, String name, String typeName, Map<String, Serializable> properties) void
void
void
void
void
SQLSession.setProxyTarget
(Document proxy, Document target) void
SQLDocumentLive.setTargetDocument
(Document target) void
SQLDocumentProxy.setTargetDocument
(Document target) -
Uses of Document in org.nuxeo.ecm.core.storage.sql.security
Modifier and TypeMethodDescriptionNoFileSecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) -
Uses of Document in org.nuxeo.ecm.core.versioning
Modifier and TypeMethodDescriptionStandardVersioningService.doCheckIn
(Document doc, VersioningOption option, String checkinComment) VersioningComponent.doCheckIn
(Document doc, VersioningOption option, String checkinComment) StandardVersioningService.doPostSave
(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String, Serializable> options) VersioningComponent.doPostSave
(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String, Serializable> options) Modifier and TypeMethodDescriptionStandardVersioningService.doCheckIn
(Document doc, VersioningOption option, String checkinComment) VersioningComponent.doCheckIn
(Document doc, VersioningOption option, String checkinComment) void
StandardVersioningService.doCheckOut
(Document doc) void
VersioningComponent.doCheckOut
(Document doc) void
StandardVersioningService.doPostCreate
(Document doc, Map<String, Serializable> options) void
VersioningComponent.doPostCreate
(Document doc, Map<String, Serializable> options) StandardVersioningService.doPostSave
(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String, Serializable> options) VersioningComponent.doPostSave
(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String, Serializable> options) StandardVersioningService.doPreSave
(CoreSession session, Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String, Serializable> options) VersioningComponent.doPreSave
(CoreSession session, Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String, Serializable> options) protected void
StandardVersioningService.followTransitionByOption
(CoreSession session, Document doc, Map<String, Serializable> options) protected long
protected long
protected List<VersioningOption>
StandardVersioningService.getSaveOptions
(Document doc) protected long
StandardVersioningService.getVersion
(Document doc, String prop) protected void
StandardVersioningService.incrementByOption
(Document doc, VersioningOption option) protected void
StandardVersioningService.incrementMajor
(Document doc) protected void
StandardVersioningService.incrementMinor
(Document doc) boolean
StandardVersioningService.isPostSaveDoingCheckIn
(Document doc, VersioningOption option, Map<String, Serializable> options) boolean
VersioningComponent.isPostSaveDoingCheckIn
(Document doc, VersioningOption option, Map<String, Serializable> options) boolean
StandardVersioningService.isPreSaveDoingCheckOut
(Document doc, boolean isDirty, VersioningOption option, Map<String, Serializable> options) boolean
VersioningComponent.isPreSaveDoingCheckOut
(Document doc, boolean isDirty, VersioningOption option, Map<String, Serializable> options) void
DefaultVersionRemovalPolicy.removeVersions
(Session session, Document doc, CoreSession coreSession) void
NullVersionRemovalPolicy.removeVersions
(Session session, Document doc, CoreSession coreSession) void
VersionRemovalPolicy.removeVersions
(Session session, Document doc, CoreSession coreSession) Removes the versions when a given working document is about to be removed.protected void
StandardVersioningService.sendEvent
(CoreSession session, Document doc, String previousLifecycleState, Map<String, Serializable> options) protected void
StandardVersioningService.setInitialVersion
(Document doc) Sets the initial version on a document.protected void
StandardVersioningService.setVersion
(Document doc, long major, long minor) protected VersioningOption
StandardVersioningService.validateOption
(Document doc, VersioningOption option) -
Uses of Document in org.nuxeo.ecm.liveconnect.box
-
Uses of Document in org.nuxeo.ecm.liveconnect.google.drive
Modifier and TypeMethodDescriptionGoogleDriveBlobProvider.freezeVersion
(ManagedBlob blob, Document doc) protected void
GoogleDriveBlobProvider.storeBlobConversion
(Document doc, String blobKey, Blob blob) Store a conversion of the given blob -
Uses of Document in org.nuxeo.ecm.platform.mail.security
Modifier and TypeMethodDescriptionMailMessageSecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals) -
Uses of Document in org.nuxeo.wopi.lock
Modifier and TypeMethodDescriptionWOPILockSecurityPolicy.checkPermission
(Document doc, ACP mergedAcp, NuxeoPrincipal principal, String permission, String[] resolvedPermissions, String[] additionalPrincipals)
AbstractSession.checkCanRemoveDocument(Document)