Uses of Interface
org.nuxeo.ecm.core.api.DocumentRef

Packages that use DocumentRef

Package	Description
org.nuxeo.automation.scripting.internals
org.nuxeo.drive.adapter.impl
org.nuxeo.drive.service.impl
org.nuxeo.ecm.automation.core.collectors
org.nuxeo.ecm.automation.core.impl.adapters
org.nuxeo.ecm.automation.core.impl.adapters.helper
org.nuxeo.ecm.automation.core.operations.document
org.nuxeo.ecm.automation.core.operations.stack
org.nuxeo.ecm.automation.core.scripting
org.nuxeo.ecm.automation.jaxrs.io.operations
org.nuxeo.ecm.core.api	The core API of the Nuxeo platform, including: CoreSession, DocumentModel, Blob.
org.nuxeo.ecm.core.api.impl
org.nuxeo.ecm.core.api.localconfiguration
org.nuxeo.ecm.core.api.trash
org.nuxeo.ecm.core.bulk.action
org.nuxeo.ecm.core.event.impl	Event Service implementation.
org.nuxeo.ecm.core.io
org.nuxeo.ecm.core.io.impl
org.nuxeo.ecm.core.io.impl.plugins
org.nuxeo.ecm.core.management.storage
org.nuxeo.ecm.core.model
org.nuxeo.ecm.core.opencmis.impl.server
org.nuxeo.ecm.core.rest
org.nuxeo.ecm.core.security
org.nuxeo.ecm.core.storage
org.nuxeo.ecm.core.trash
org.nuxeo.ecm.csv.core
org.nuxeo.ecm.directory.localconfiguration
org.nuxeo.ecm.localconf
org.nuxeo.ecm.permissions.operations
org.nuxeo.ecm.platform.audit.api
org.nuxeo.ecm.platform.audit.api.comment
org.nuxeo.ecm.platform.audit.impl
org.nuxeo.ecm.platform.audit.io
org.nuxeo.ecm.platform.audit.service
org.nuxeo.ecm.platform.comment.api
org.nuxeo.ecm.platform.comment.impl
org.nuxeo.ecm.platform.comment.workflow
org.nuxeo.ecm.platform.comment.workflow.utils
org.nuxeo.ecm.platform.content.template.factories
org.nuxeo.ecm.platform.dublincore.listener
org.nuxeo.ecm.platform.io.api
org.nuxeo.ecm.platform.io.impl
org.nuxeo.ecm.platform.picture.operation
org.nuxeo.ecm.platform.publisher.api
org.nuxeo.ecm.platform.publisher.impl.core
org.nuxeo.ecm.platform.publisher.rules
org.nuxeo.ecm.platform.publisher.task
org.nuxeo.ecm.platform.relations.io
org.nuxeo.ecm.platform.rendition.lazy
org.nuxeo.ecm.platform.rendition.publisher
org.nuxeo.ecm.platform.rendition.service
org.nuxeo.ecm.platform.routing.api	Provides the interfaces necessary to create and manipulate DocumentRoute.
org.nuxeo.ecm.platform.routing.core.impl	Provides implementation for the api package.
org.nuxeo.ecm.platform.task.dashboard
org.nuxeo.ecm.platform.types.localconfiguration
org.nuxeo.ecm.quota.automation
org.nuxeo.ecm.restapi.server.jaxrs
org.nuxeo.ecm.webdav.backend
org.nuxeo.ecm.webengine.util
org.nuxeo.snapshot
org.nuxeo.template.adapters.doc
org.nuxeo.template.api.adapters
org.nuxeo.template.service
org.nuxeo.theme.localconfiguration

Uses of DocumentRef in org.nuxeo.automation.scripting.internals

Methods in org.nuxeo.automation.scripting.internals that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	DocumentScriptingWrapper.getRef()
DocumentRef	DocumentScriptingWrapper.resolvePathAsRef(String relative)

Uses of DocumentRef in org.nuxeo.drive.adapter.impl

Method parameters in org.nuxeo.drive.adapter.impl with type arguments of type DocumentRef

Modifier and Type	Method	Description
protected FolderItem	DocumentBackedFolderItem.getFolderItem(Map<DocumentRef,FolderItem> cache, DocumentModel doc, FolderItem parentItem, boolean cacheItem)
protected FolderItem	DocumentBackedFolderItem.populateAncestorCache(Map<DocumentRef,FolderItem> cache, DocumentModel doc, CoreSession session, boolean cacheItem)

Uses of DocumentRef in org.nuxeo.drive.service.impl

Methods in org.nuxeo.drive.service.impl with parameters of type DocumentRef

Modifier and Type	Method	Description
protected FileSystemItemChange	AuditChangeFinder.getFileSystemItemChange(CoreSession session, DocumentRef docRef, LogEntry entry, String expectedFileSystemItemId)

Uses of DocumentRef in org.nuxeo.ecm.automation.core.collectors

Methods in org.nuxeo.ecm.automation.core.collectors with parameters of type DocumentRef

Modifier and Type	Method	Description
void	DocumentRefCollector.collect(OperationContext ctx, DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.automation.core.impl.adapters

Methods in org.nuxeo.ecm.automation.core.impl.adapters that return DocumentRef

Modifier and Type	Method	Description
static DocumentRef	StringToDocRef.createRef(String value)	Deprecated. since 9.1, see TypeAdapterHelper.createDocumentRef(String) instead
DocumentRef	StringToDocRef.getAdaptedValue(OperationContext ctx, Object objectToAdapt)

Uses of DocumentRef in org.nuxeo.ecm.automation.core.impl.adapters.helper

Classes in org.nuxeo.ecm.automation.core.impl.adapters.helper that implement DocumentRef

Modifier and Type	Class	Description
class	AbsoluteDocumentRef	An absolute reference to a DocumentModel, composed of:

Fields in org.nuxeo.ecm.automation.core.impl.adapters.helper declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	AbsoluteDocumentRef.documentRef

Methods in org.nuxeo.ecm.automation.core.impl.adapters.helper that return DocumentRef

Modifier and Type	Method	Description
static DocumentRef	TypeAdapterHelper.createDocumentRef(String value)	Create document reference from an id or a path.
static DocumentRef	TypeAdapterHelper.createDocumentRef(OperationContext ctx, String value)	Create a document reference from its path

Methods in org.nuxeo.ecm.automation.core.impl.adapters.helper with parameters of type DocumentRef

Modifier and Type	Method	Description
static DocumentModel	TypeAdapterHelper.createDocumentModel(OperationContext ctx, DocumentRef docRef)	Create a document model from its reference

Constructors in org.nuxeo.ecm.automation.core.impl.adapters.helper with parameters of type DocumentRef

Constructor	Description
AbsoluteDocumentRef(String repositoryName, DocumentRef documentRef)

Uses of DocumentRef in org.nuxeo.ecm.automation.core.operations.document

Fields in org.nuxeo.ecm.automation.core.operations.document declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	CopyDocument.target
protected DocumentRef	MoveDocument.target

Methods in org.nuxeo.ecm.automation.core.operations.document with parameters of type DocumentRef

Modifier and Type	Method	Description
protected void	RemoveDocumentACL.deleteACL(DocumentRef ref)
DocumentModel	AddPermission.run(DocumentRef docRef)
DocumentModel	BlockPermissionInheritance.run(DocumentRef docRef)
DocumentModel	CheckInDocument.run(DocumentRef doc)
DocumentModel	CheckOutDocument.run(DocumentRef doc)
DocumentModel	CopyDocument.run(DocumentRef ref)
DocumentModel	CreateDocument.run(DocumentRef doc)
DocumentModel	DeleteDocument.run(DocumentRef doc)
DocumentModel	GetDocumentChild.run(DocumentRef doc)
DocumentModelList	GetDocumentChildren.run(DocumentRef doc)
DocumentModel	GetDocumentParent.run(DocumentRef doc)
DocumentModel	LockDocument.run(DocumentRef doc)
DocumentModel	MoveDocument.run(DocumentRef ref)
DocumentModel	RemoveDocumentACL.run(DocumentRef doc)
DocumentModel	RemovePermission.run(DocumentRef docRef)
DocumentModel	ReplacePermission.run(DocumentRef docRef)
DocumentModel	SetDocumentACE.run(DocumentRef doc)
DocumentModel	SetDocumentLifeCycle.run(DocumentRef doc)
DocumentModel	UnblockPermissionInheritance.run(DocumentRef docRef)
DocumentModel	UnlockDocument.run(DocumentRef doc)
protected void	SetDocumentACE.setACE(DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.automation.core.operations.stack

Methods in org.nuxeo.ecm.automation.core.operations.stack that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	PushDocument.run(DocumentRef doc)

Methods in org.nuxeo.ecm.automation.core.operations.stack with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentRef	PushDocument.run(DocumentRef doc)

Uses of DocumentRef in org.nuxeo.ecm.automation.core.scripting

Methods in org.nuxeo.ecm.automation.core.scripting that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	DocumentWrapper.getRef()
DocumentRef	DocumentWrapper.resolvePathAsRef(String relative)

Uses of DocumentRef in org.nuxeo.ecm.automation.jaxrs.io.operations

Methods in org.nuxeo.ecm.automation.jaxrs.io.operations that return DocumentRef

Modifier and Type	Method	Description
static DocumentRef	DocumentInputResolver.docRefFromString(String input)
DocumentRef	DocumentInputResolver.getInput(String content)
protected static DocumentRef	DocumentInputResolver.relativeDocRefFromString(String input)

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

Classes in org.nuxeo.ecm.core.api that implement DocumentRef

Modifier and Type	Class	Description
class	IdRef	An ID reference to a document.
class	InstanceRef	Document repository reference including the principal owner of the session.
class	PathRef	A PATH reference to a document.

Methods in org.nuxeo.ecm.core.api that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	AbstractSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment)
DocumentRef	CoreSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment)	Checks in a modified document, creating a new version.
DocumentRef	DocumentModel.checkIn(VersioningOption option, String checkinComment)	Checks in a document and returns the created version.
DocumentRef	AbstractSession.getBaseVersion(DocumentRef docRef)
DocumentRef	CoreSession.getBaseVersion(DocumentRef docRef)	Gets the version to which a checked in document is linked.
DocumentRef	DocumentLocation.getDocRef()	Returns the document reference.
DocumentRef	AbstractSession.getLastDocumentVersionRef(DocumentRef docRef)
DocumentRef	CoreSession.getLastDocumentVersionRef(DocumentRef docRef)	Gets the document reference corresponding to the last version for the given document.
DocumentRef	AbstractSession.getParentDocumentRef(DocumentRef docRef)
DocumentRef	CoreSession.getParentDocumentRef(DocumentRef docRef)	Returns the parent ref of the document referenced by docRef or null if this is the root document.
DocumentRef[]	AbstractSession.getParentDocumentRefs(DocumentRef docRef)
DocumentRef[]	CoreSession.getParentDocumentRefs(DocumentRef docRef)	Creates an array with all parent refs starting from the given document up to the root.
DocumentRef	DocumentModel.getParentRef()	Retrieves the parent reference of the current document.
DocumentRef	DocumentModel.getRef()	Gets a reference to the core document that can be used either remotely or locally (opens the core JVM).

Methods in org.nuxeo.ecm.core.api that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
List<DocumentRef>	AbstractSession.getChildrenRefs(DocumentRef parentRef, String perm)
List<DocumentRef>	CoreSession.getChildrenRefs(DocumentRef parentRef, String perm)	Gets the references of the children.
List<DocumentRef>	AbstractSession.getVersionsRefs(DocumentRef docRef)
List<DocumentRef>	CoreSession.getVersionsRefs(DocumentRef docRef)	Gets the references of the versions of the document.
List<DocumentRef>	AbstractSession.removeOrphanVersions(DocumentRef docRef)
List<DocumentRef>	CoreSession.removeOrphanVersions(DocumentRef docRef)	Removes orphan versions when the live document doesn't exist and there is no proxy pointing to this document.

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

Modifier and Type	Method	Description
<T extends DetachedAdapter> T	AbstractSession.adaptFirstMatchingDocumentWithFacet(DocumentRef docRef, String facet, Class<T> adapterClass)
<T extends DetachedAdapter> T	CoreSession.adaptFirstMatchingDocumentWithFacet(DocumentRef docRef, String facet, Class<T> adapterClass)	Find the first parent with the given facet and adapt it on the adapterClass.
boolean	AbstractSession.canRemoveDocument(DocumentRef docRef)
boolean	CoreSession.canRemoveDocument(DocumentRef docRef)	Check if a document can be removed.
DocumentRef	AbstractSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment)
DocumentRef	CoreSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment)	Checks in a modified document, creating a new version.
void	AbstractSession.checkOut(DocumentRef docRef)
void	CoreSession.checkOut(DocumentRef docRef)	Checks out a versioned document.
List<DocumentModel>	AbstractSession.copy(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated.
List<DocumentModel>	AbstractSession.copy(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... opts)
DocumentModel	AbstractSession.copy(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle)	Deprecated.
DocumentModel	AbstractSession.copy(DocumentRef src, DocumentRef dst, String name, CoreSession.CopyOption... copyOptions)
List<DocumentModel>	CoreSession.copy(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated. Since 8.2.
List<DocumentModel>	CoreSession.copy(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... copyOptions)	Bulk copy.
DocumentModel	CoreSession.copy(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle)	Deprecated. Since 8.2.
DocumentModel	CoreSession.copy(DocumentRef src, DocumentRef dst, String name, CoreSession.CopyOption... copyOptions)	Copies the source document to the destination folder under the given name.
List<DocumentModel>	AbstractSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated.
List<DocumentModel>	AbstractSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... opts)
DocumentModel	AbstractSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle)	Deprecated.
DocumentModel	AbstractSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name, CoreSession.CopyOption... copyOptions)
List<DocumentModel>	CoreSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated. Since 8.2.
List<DocumentModel>	CoreSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... copyOptions)	Bulk copyProxyAsDocument.
DocumentModel	CoreSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle)	Deprecated. Since 8.2.
DocumentModel	CoreSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name, CoreSession.CopyOption... copyOptions)	Work like copy but in the case of a source proxy the destination will be a new document instead of a proxy.
static DocumentModelImpl	DocumentModelFactory.createDocumentModel(String typeName, DocumentRef parentRef, CoreSession coreSession)	Creates a document model for a new document.
DocumentModel	AbstractSession.createProxy(DocumentRef docRef, DocumentRef folderRef)
DocumentModel	CoreSession.createProxy(DocumentRef docRef, DocumentRef folderRef)	Creates a generic proxy to the given document inside the given folder.
boolean	AbstractSession.exists(DocumentRef docRef)
boolean	CoreSession.exists(DocumentRef docRef)	Tests if the document pointed by the given reference exists and is accessible.
protected Document	AbstractSession.fillCreateOptions(DocumentRef parentRef, String childName, Map<String,Serializable> options)
Collection<String>	AbstractSession.filterGrantedPermissions(NuxeoPrincipal principal, DocumentRef docRef, Collection<String> permissions)
Collection<String>	CoreSession.filterGrantedPermissions(NuxeoPrincipal principal, DocumentRef docRef, Collection<String> permissions)	Filters the supplied permissions based on whether they are granted to a given principal for a given document.
boolean	AbstractSession.followTransition(DocumentRef docRef, String transition)
boolean	CoreSession.followTransition(DocumentRef docRef, String transition)	Follows a given life cycle transition.
ACP	AbstractSession.getACP(DocumentRef docRef)
ACP	CoreSession.getACP(DocumentRef docRef)	Gets the document access control policy.
Collection<String>	AbstractSession.getAllowedStateTransitions(DocumentRef docRef)
Collection<String>	CoreSession.getAllowedStateTransitions(DocumentRef docRef)	Gets the allowed state transitions for this document.
DocumentRef	AbstractSession.getBaseVersion(DocumentRef docRef)
DocumentRef	CoreSession.getBaseVersion(DocumentRef docRef)	Gets the version to which a checked in document is linked.
Map<String,String>	AbstractSession.getBinaryFulltext(DocumentRef ref)
Map<String,String>	CoreSession.getBinaryFulltext(DocumentRef ref)	Gets the fulltext extracted from the binary fields.
String	AbstractSession.getChangeToken(DocumentRef ref)
String	CoreSession.getChangeToken(DocumentRef ref)	Gets the current change token for the document.
DocumentModel	AbstractSession.getChild(DocumentRef parent, String name)
DocumentModel	CoreSession.getChild(DocumentRef parent, String name)	Gets a child document given its name and the parent reference.
DocumentModelList	AbstractSession.getChildren(DocumentRef parent)
DocumentModelList	AbstractSession.getChildren(DocumentRef parent, String type)
DocumentModelList	AbstractSession.getChildren(DocumentRef parent, String type, String perm)
DocumentModelList	AbstractSession.getChildren(DocumentRef parent, String type, String perm, Filter filter, Sorter sorter)
DocumentModelList	AbstractSession.getChildren(DocumentRef parent, String type, Filter filter, Sorter sorter)
DocumentModelList	CoreSession.getChildren(DocumentRef parent)	Gets the children of the given parent.
DocumentModelList	CoreSession.getChildren(DocumentRef parent, String type)	Gets the children of the given parent filtered according to the given document type.
DocumentModelList	CoreSession.getChildren(DocumentRef parent, String type, String perm)	Gets the children of the given parent filtered according to the given document type and permission.
DocumentModelList	CoreSession.getChildren(DocumentRef parent, String type, String perm, Filter filter, Sorter sorter)	Same as CoreSession.getChildren(DocumentRef, String, String) but the result is filtered and then sorted using the specified filter and sorter.
DocumentModelList	CoreSession.getChildren(DocumentRef parent, String type, Filter filter, Sorter sorter)	Same as CoreSession.getChildren(DocumentRef, String, String, Filter, Sorter) without specific permission filtering.
DocumentModelIterator	AbstractSession.getChildrenIterator(DocumentRef parent)
DocumentModelIterator	AbstractSession.getChildrenIterator(DocumentRef parent, String type)
DocumentModelIterator	AbstractSession.getChildrenIterator(DocumentRef parent, String type, String perm, Filter filter)
DocumentModelIterator	CoreSession.getChildrenIterator(DocumentRef parent)	Gets an iterator to the children of the given parent.
DocumentModelIterator	CoreSession.getChildrenIterator(DocumentRef parent, String type)	Gets an iterator to the children of the given parent filtered according to the given document type.
DocumentModelIterator	CoreSession.getChildrenIterator(DocumentRef parent, String type, String perm, Filter filter)	Gets the children of the given parent filtered according to the given document type and permission.
List<DocumentRef>	AbstractSession.getChildrenRefs(DocumentRef parentRef, String perm)
List<DocumentRef>	CoreSession.getChildrenRefs(DocumentRef parentRef, String perm)	Gets the references of the children.
String	AbstractSession.getCurrentLifeCycleState(DocumentRef docRef)
String	CoreSession.getCurrentLifeCycleState(DocumentRef docRef)	Returns the life cycle of the document.
DataModel	AbstractSession.getDataModel(DocumentRef docRef, Schema schema)
DataModel	CoreSession.getDataModel(DocumentRef docRef, Schema schema)	Retrieves a data model given a document reference and a schema.
protected Object	AbstractSession.getDataModelField(DocumentRef docRef, String schema, String field)
Object[]	AbstractSession.getDataModelsField(DocumentRef[] docRefs, String schema, String field)
Object[]	CoreSession.getDataModelsField(DocumentRef[] docRefs, String schema, String field)	Retrieves the given field value from the given schema for all the given documents.
Object[]	AbstractSession.getDataModelsFieldUp(DocumentRef docRef, String schema, String field)
Object[]	CoreSession.getDataModelsFieldUp(DocumentRef docRef, String schema, String field)	Retrieves the given field value from the given schema for the given document along with all its parent documents.
DocumentModel	AbstractSession.getDocument(DocumentRef docRef)
DocumentModel	CoreSession.getDocument(DocumentRef docRef)	Gets a document model given its reference.
DocumentModelList	AbstractSession.getDocuments(DocumentRef[] docRefs)
DocumentModelList	CoreSession.getDocuments(DocumentRef[] docRefs)	Gets a list of documents given their references.
<T extends Serializable> T	AbstractSession.getDocumentSystemProp(DocumentRef ref, String systemProperty, Class<T> type)
<T extends Serializable> T	CoreSession.getDocumentSystemProp(DocumentRef ref, String systemProperty, Class<T> type)	Gets system property of the specified type for the document ref.
DocumentModel	AbstractSession.getDocumentWithVersion(DocumentRef docRef, VersionModel version)
DocumentModel	CoreSession.getDocumentWithVersion(DocumentRef docRef, VersionModel version)	Returns a document that represents the specified version of the document.
DocumentModelList	AbstractSession.getFiles(DocumentRef parent)
DocumentModelList	AbstractSession.getFiles(DocumentRef parent, Filter filter, Sorter sorter)
DocumentModelList	CoreSession.getFiles(DocumentRef parent)	Same as CoreSession.getChildren(DocumentRef) but returns only non-folder documents.
DocumentModelList	CoreSession.getFiles(DocumentRef parent, Filter filter, Sorter sorter)	Same as CoreSession.getFiles(org.nuxeo.ecm.core.api.DocumentRef) but uses an optional filter and sorter on the result.
protected Document	AbstractSession.getFirstParentDocumentWithFacet(DocumentRef docRef, String facet)	Returns the first Document with the given facet, recursively going up the parent hierarchy.
DocumentModelList	AbstractSession.getFolders(DocumentRef parent)
DocumentModelList	AbstractSession.getFolders(DocumentRef parent, Filter filter, Sorter sorter)
DocumentModelList	CoreSession.getFolders(DocumentRef parent)	Same as CoreSession.getChildren(DocumentRef) but returns only folder documents.
DocumentModelList	CoreSession.getFolders(DocumentRef parent, Filter filter, Sorter sorter)	Same as CoreSession.getFolders(DocumentRef) but uses an optional filter and sorter on the result.
DocumentModel	AbstractSession.getLastDocumentVersion(DocumentRef docRef)
DocumentModel	CoreSession.getLastDocumentVersion(DocumentRef docRef)	Gets the document corresponding to the last version for the given document.
DocumentRef	AbstractSession.getLastDocumentVersionRef(DocumentRef docRef)
DocumentRef	CoreSession.getLastDocumentVersionRef(DocumentRef docRef)	Gets the document reference corresponding to the last version for the given document.
String	AbstractSession.getLifeCyclePolicy(DocumentRef docRef)
String	CoreSession.getLifeCyclePolicy(DocumentRef docRef)	Returns the life cycle policy of the document.
Lock	AbstractSession.getLockInfo(DocumentRef docRef)
Lock	CoreSession.getLockInfo(DocumentRef docRef)	Gets the lock info on the given document.
DocumentModel	AbstractSession.getParentDocument(DocumentRef docRef)
DocumentModel	CoreSession.getParentDocument(DocumentRef docRef)	Gets the parent document or null if this is the root document.
DocumentRef	AbstractSession.getParentDocumentRef(DocumentRef docRef)
DocumentRef	CoreSession.getParentDocumentRef(DocumentRef docRef)	Returns the parent ref of the document referenced by docRef or null if this is the root document.
DocumentRef[]	AbstractSession.getParentDocumentRefs(DocumentRef docRef)
DocumentRef[]	CoreSession.getParentDocumentRefs(DocumentRef docRef)	Creates an array with all parent refs starting from the given document up to the root.
List<DocumentModel>	AbstractSession.getParentDocuments(DocumentRef docRef)
List<DocumentModel>	CoreSession.getParentDocuments(DocumentRef docRef)	Gets the parent documents in path from the root to the given document or empty list if this is the root document.
DocumentModelList	AbstractSession.getProxies(DocumentRef docRef, DocumentRef folderRef)
DocumentModelList	CoreSession.getProxies(DocumentRef docRef, DocumentRef folderRef)	Finds the proxies for a document.
List<String>	AbstractSession.getRetainedProperties(DocumentRef docRef)
List<String>	CoreSession.getRetainedProperties(DocumentRef docRef)	Gets the retained property xpaths of this document at the time it became a record.
Calendar	AbstractSession.getRetainUntil(DocumentRef docRef)
Calendar	CoreSession.getRetainUntil(DocumentRef docRef)	Gets the retention date for the document.
DocumentModel	AbstractSession.getSourceDocument(DocumentRef docRef)
DocumentModel	CoreSession.getSourceDocument(DocumentRef docRef)	Gets the head (live) document for this document.
List<DocumentModel>	AbstractSession.getVersions(DocumentRef docRef)
List<DocumentModel>	CoreSession.getVersions(DocumentRef docRef)	Retrieves all the versions for a specified document.
String	AbstractSession.getVersionSeriesId(DocumentRef docRef)
String	CoreSession.getVersionSeriesId(DocumentRef docRef)	Gets the version series id for a document.
List<VersionModel>	AbstractSession.getVersionsForDocument(DocumentRef docRef)
List<VersionModel>	CoreSession.getVersionsForDocument(DocumentRef docRef)	Retrieves all the versions for a specified document.
List<DocumentRef>	AbstractSession.getVersionsRefs(DocumentRef docRef)
List<DocumentRef>	CoreSession.getVersionsRefs(DocumentRef docRef)	Gets the references of the versions of the document.
DocumentModel	AbstractSession.getWorkingCopy(DocumentRef docRef)
DocumentModel	CoreSession.getWorkingCopy(DocumentRef docRef)	Gets the working copy (live document) for a proxy or a version.
boolean	AbstractSession.hasChild(DocumentRef parent, String name)
boolean	CoreSession.hasChild(DocumentRef parent, String name)	Tests if the document has a child with the given name.
boolean	AbstractSession.hasChildren(DocumentRef docRef)
boolean	CoreSession.hasChildren(DocumentRef docRef)	Tests if the document has any children.
boolean	AbstractSession.hasLegalHold(DocumentRef docRef)
boolean	CoreSession.hasLegalHold(DocumentRef docRef)	Checks if the document has a legal hold set.
boolean	AbstractSession.hasPermission(DocumentRef docRef, String permission)
boolean	AbstractSession.hasPermission(NuxeoPrincipal principal, DocumentRef docRef, String permission)
boolean	CoreSession.hasPermission(DocumentRef docRef, String permission)	Checks if the principal that created the client session has the given privilege on the referred document.
boolean	CoreSession.hasPermission(NuxeoPrincipal principal, DocumentRef docRef, String permission)	Checks if a given principal has the given privilege on the referred document.
boolean	AbstractSession.isCheckedOut(DocumentRef docRef)
boolean	CoreSession.isCheckedOut(DocumentRef docRef)	Returns whether the current document is checked-out or not.
boolean	AbstractSession.isEnforcedRecord(DocumentRef docRef)
default boolean	CoreSession.isEnforcedRecord(DocumentRef docRef)	Checks if the document is an enforced record.
boolean	AbstractSession.isFlexibleRecord(DocumentRef docRef)
default boolean	CoreSession.isFlexibleRecord(DocumentRef docRef)	Checks if the document is a flexible record.
boolean	AbstractSession.isRecord(DocumentRef docRef)
boolean	CoreSession.isRecord(DocumentRef docRef)	Checks if the document is a record.
boolean	AbstractSession.isRetentionActive(DocumentRef docRef)
boolean	CoreSession.isRetentionActive(DocumentRef docRef)	Deprecated. since 11.1, unused, use CoreSession.hasLegalHold(org.nuxeo.ecm.core.api.DocumentRef) instead
boolean	AbstractSession.isTrashed(DocumentRef docRef)
boolean	CoreSession.isTrashed(DocumentRef docRef)	Checks if this document is in the trash.
boolean	AbstractSession.isUnderRetentionOrLegalHold(DocumentRef docRef)
boolean	CoreSession.isUnderRetentionOrLegalHold(DocumentRef docRef)	Checks if the document has a retention date in the future or has a legal hold.
void	AbstractSession.makeFlexibleRecord(DocumentRef docRef)
default void	CoreSession.makeFlexibleRecord(DocumentRef docRef)	Turns the document into a flexible record.
void	AbstractSession.makeRecord(DocumentRef docRef)
protected void	AbstractSession.makeRecord(DocumentRef docRef, boolean flexible)
void	CoreSession.makeRecord(DocumentRef docRef)	Turns the document into an enforced record.
void	AbstractSession.move(List<DocumentRef> src, DocumentRef dst)
DocumentModel	AbstractSession.move(DocumentRef src, DocumentRef dst, String name)
void	CoreSession.move(List<DocumentRef> src, DocumentRef dst)	Bulk move.
DocumentModel	CoreSession.move(DocumentRef src, DocumentRef dst, String name)	Moves the source document to the destination folder under the given name.
DocumentModel	AbstractSession.newDocumentModel(DocumentRef parentRef, String name, String typeName)
DocumentModel	CoreSession.newDocumentModel(DocumentRef parentRef, String name, String typeName)	Creates a new document model using required information.
protected void	AbstractSession.notifyCheckedInVersion(DocumentModel docModel, DocumentRef checkedInVersionRef, Map<String,Serializable> options, String checkinComment)	Send a core event for the creation of a new check in version.
void	AbstractSession.orderBefore(DocumentRef parent, String src, String dest)
void	CoreSession.orderBefore(DocumentRef parent, String src, String dest)	Given a parent document, order the source child before the destination child.
DocumentModel.DocumentModelRefresh	AbstractSession.refreshDocument(DocumentRef ref, int refreshFlags, String[] schemas)
DocumentModel.DocumentModelRefresh	CoreSession.refreshDocument(DocumentRef ref, int refreshFlags, String[] schemas)	Internal method - it is used internally by DocumentModel.refresh()
void	AbstractSession.reinitLifeCycleState(DocumentRef docRef)
void	CoreSession.reinitLifeCycleState(DocumentRef docRef)	Reinitializes the life cycle state of the document to its default state.
void	AbstractSession.removeChildren(DocumentRef docRef)
void	CoreSession.removeChildren(DocumentRef docRef)	Removes all children from the given document.
void	AbstractSession.removeDocument(DocumentRef docRef)
void	CoreSession.removeDocument(DocumentRef docRef)	Removes this document and all its children, if any.
void	AbstractSession.removeDocuments(DocumentRef[] docRefs)	Implementation uses the fact that the lexicographic ordering of paths is a refinement of the "contains" partial ordering.
void	CoreSession.removeDocuments(DocumentRef[] docRefs)	Bulk method to remove documents.
Lock	AbstractSession.removeLock(DocumentRef docRef)
Lock	CoreSession.removeLock(DocumentRef docRef)	Removes the lock on the given document.
List<DocumentRef>	AbstractSession.removeOrphanVersions(DocumentRef docRef)
List<DocumentRef>	CoreSession.removeOrphanVersions(DocumentRef docRef)	Removes orphan versions when the live document doesn't exist and there is no proxy pointing to this document.
void	AbstractSession.replaceACE(DocumentRef docRef, String aclName, ACE oldACE, ACE newACE)
void	CoreSession.replaceACE(DocumentRef docRef, String aclName, ACE oldACE, ACE newACE)	Replace the oldACE with the newACE on the given aclName.
String	AbstractSession.replaceBlobDigest(DocumentRef docRef, String key, String newKey, String newDigest)
String	CoreSession.replaceBlobDigest(DocumentRef docRef, String key, String newKey, String newDigest)	Visits the blobs of a document and, for those with a matching key, replace their key and digest with new ones.
protected Document	AbstractSession.resolveParentReference(DocumentRef docRef)
protected Document	AbstractSession.resolveReference(DocumentRef docRef)
DocumentModel	AbstractSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef)
DocumentModel	AbstractSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef, boolean skipSnapshotCreation, boolean skipCheckout)
DocumentModel	CoreSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef)	Restores the given document to the specified version.
DocumentModel	CoreSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef, boolean skipSnapshotCreation, boolean skipCheckout)	Restores the given document to the specified version.
void	AbstractSession.setACP(DocumentRef docRef, ACP newAcp, boolean overwrite)
void	CoreSession.setACP(DocumentRef docRef, ACP acp, boolean overwrite)	Sets the ACP for this document.
<T extends Serializable> void	AbstractSession.setDocumentSystemProp(DocumentRef ref, String systemProperty, T value)
<T extends Serializable> void	CoreSession.setDocumentSystemProp(DocumentRef ref, String systemProperty, T value)	Sets given value as a system property.
void	AbstractSession.setLegalHold(DocumentRef docRef, boolean hold, String comment)
void	CoreSession.setLegalHold(DocumentRef docRef, boolean hold, String comment)	Sets or removes the legal hold on the document (a record).
Lock	AbstractSession.setLock(DocumentRef docRef)
Lock	CoreSession.setLock(DocumentRef docRef)	Sets a lock on the given document.
void	AbstractSession.setRetainUntil(DocumentRef docRef, Calendar retainUntil, String comment)
void	CoreSession.setRetainUntil(DocumentRef docRef, Calendar retainUntil, String comment)	Sets the retention date on the document (a record).
void	AbstractSession.setRetentionActive(DocumentRef docRef, boolean retentionActive)
void	CoreSession.setRetentionActive(DocumentRef docRef, boolean retentionActive)	Deprecated. since 11.1, unused, use CoreSession.setLegalHold(org.nuxeo.ecm.core.api.DocumentRef, boolean, java.lang.String) instead
void	AbstractSession.unsetRetainUntil(DocumentRef docRef)
default void	CoreSession.unsetRetainUntil(DocumentRef docRef)	Removes the retainUntil date, this operation is allowed only for a flexible record.

Method parameters in org.nuxeo.ecm.core.api with type arguments of type DocumentRef

Modifier and Type	Method	Description
List<DocumentModel>	AbstractSession.copy(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated.
List<DocumentModel>	AbstractSession.copy(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... opts)
List<DocumentModel>	CoreSession.copy(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated. Since 8.2.
List<DocumentModel>	CoreSession.copy(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... copyOptions)	Bulk copy.
List<DocumentModel>	AbstractSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated.
List<DocumentModel>	AbstractSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... opts)
List<DocumentModel>	CoreSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)	Deprecated. Since 8.2.
List<DocumentModel>	CoreSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, CoreSession.CopyOption... copyOptions)	Bulk copyProxyAsDocument.
void	AbstractSession.move(List<DocumentRef> src, DocumentRef dst)
void	CoreSession.move(List<DocumentRef> src, DocumentRef dst)	Bulk move.

Uses of DocumentRef in org.nuxeo.ecm.core.api.impl

Fields in org.nuxeo.ecm.core.api.impl declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	DocumentModelImpl.parentRef
protected DocumentRef	DocumentModelImpl.ref

Methods in org.nuxeo.ecm.core.api.impl that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	DocumentModelImpl.checkIn(VersioningOption option, String description)
DocumentRef	SimpleDocumentModel.checkIn(VersioningOption option, String description)
DocumentRef	DocumentLocationImpl.getDocRef()
DocumentRef	DocumentModelImpl.getParentRef()
DocumentRef	SimpleDocumentModel.getParentRef()
DocumentRef	DocumentModelImpl.getRef()
DocumentRef	SimpleDocumentModel.getRef()

Constructors in org.nuxeo.ecm.core.api.impl with parameters of type DocumentRef

Constructor	Description
DocumentLocationImpl(String serverName, DocumentRef docRef)
DocumentModelChildrenIterator(CoreSession session, DocumentRef parentRef, String type, Filter filter)
DocumentModelImpl(String sid, String type, String id, Path path, DocumentRef docRef, DocumentRef parentRef, String[] schemas, Set<String> facets, String sourceId, String repositoryName, boolean isProxy)	Deprecated. since 11.1, sid is unused
DocumentModelImpl(String sid, String type, String id, Path path, Lock lock, DocumentRef docRef, DocumentRef parentRef, String[] schemas, Set<String> facets, String sourceId, String repositoryName)	Deprecated. since 11.1, sid and lock are unused
DocumentModelImpl(String type, String id, Path path, DocumentRef docRef, DocumentRef parentRef, String[] schemas, Set<String> facets, String sourceId, boolean isProxy, CoreSession coreSession, String repositoryName, NuxeoPrincipal principal)

Constructor parameters in org.nuxeo.ecm.core.api.impl with type arguments of type DocumentRef

Constructor	Description
DocumentRefListImpl(List<DocumentRef> list)
DocumentRefListImpl(List<DocumentRef> list, long totalSize)	Constructs a DocumentModelListImpl and sets the "total size" information.

Uses of DocumentRef in org.nuxeo.ecm.core.api.localconfiguration

Methods in org.nuxeo.ecm.core.api.localconfiguration that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	LocalConfiguration.getDocumentRef()	Returns the related DocumentRef of this local configuration.

Uses of DocumentRef in org.nuxeo.ecm.core.api.trash

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

Modifier and Type	Method	Description
boolean	TrashService.isTrashed(CoreSession session, DocumentRef doc)
String	TrashService.unmangleName(CoreSession session, DocumentRef parentRef, String docName)	Unmangles the name of a document in the trash to find its un-trashed name.

Method parameters in org.nuxeo.ecm.core.api.trash with type arguments of type DocumentRef

Modifier and Type	Method	Description
void	TrashService.purgeDocuments(CoreSession session, List<DocumentRef> docRefs)	Purges (completely deletes) documents.

Uses of DocumentRef in org.nuxeo.ecm.core.bulk.action

Method parameters in org.nuxeo.ecm.core.bulk.action with type arguments of type DocumentRef

Modifier and Type	Method	Description
protected void	TrashAction.TrashComputation.fireEvent(CoreSession session, String eventId, Collection<DocumentRef> refs)

Uses of DocumentRef in org.nuxeo.ecm.core.event.impl

Methods in org.nuxeo.ecm.core.event.impl that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	ShallowDocumentModel.checkIn(VersioningOption option, String checkinComment)
DocumentRef	DocumentEventContext.getDestination()
DocumentRef	ShallowDocumentModel.getParentRef()
DocumentRef	ShallowDocumentModel.getRef()

Constructors in org.nuxeo.ecm.core.event.impl with parameters of type DocumentRef

Constructor	Description
DocumentEventContext(CoreSession session, NuxeoPrincipal principal, DocumentModel source, DocumentRef destDoc)

Uses of DocumentRef in org.nuxeo.ecm.core.io

Methods in org.nuxeo.ecm.core.io that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
Map<DocumentRef,DocumentRef>	DocumentTranslationMap.getDocRefMap()	Returns the unmodifiable map of document references.
Map<DocumentRef,DocumentRef>	DocumentTranslationMap.getDocRefMap()	Returns the unmodifiable map of document references.

Methods in org.nuxeo.ecm.core.io with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentTranslationMap	IODocumentManager.importDocuments(InputStream in, String repo, DocumentRef root)
void	DocumentTranslationMap.put(DocumentRef oldRef, DocumentRef newRef)

Method parameters in org.nuxeo.ecm.core.io with type arguments of type DocumentRef

Modifier and Type	Method	Description
DocumentTranslationMap	IODocumentManager.exportDocuments(OutputStream out, String repo, Collection<DocumentRef> sources, boolean recurse, String format)
void	DocumentTranslationMap.putAll(Map<DocumentRef,DocumentRef> refs)
void	DocumentTranslationMap.putAll(Map<DocumentRef,DocumentRef> refs)

Uses of DocumentRef in org.nuxeo.ecm.core.io.impl

Methods in org.nuxeo.ecm.core.io.impl that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
Map<DocumentRef,DocumentRef>	DocumentTranslationMapImpl.getDocRefMap()
Map<DocumentRef,DocumentRef>	DocumentTranslationMapImpl.getDocRefMap()

Methods in org.nuxeo.ecm.core.io.impl with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentTranslationMap	IODocumentManagerImpl.importDocuments(InputStream in, String repo, DocumentRef root)
void	DocumentTranslationMapImpl.put(DocumentRef oldRef, DocumentRef newRef)

Method parameters in org.nuxeo.ecm.core.io.impl with type arguments of type DocumentRef

Modifier and Type	Method	Description
DocumentTranslationMap	IODocumentManagerImpl.exportDocuments(OutputStream out, String repo, Collection<DocumentRef> sources, boolean recurse, String format)
void	DocumentTranslationMapImpl.putAll(Map<DocumentRef,DocumentRef> refs)
void	DocumentTranslationMapImpl.putAll(Map<DocumentRef,DocumentRef> refs)

Constructor parameters in org.nuxeo.ecm.core.io.impl with type arguments of type DocumentRef

Constructor	Description
DocumentTranslationMapImpl(String oldServerName, String newServerName, Map<DocumentRef,DocumentRef> map)
DocumentTranslationMapImpl(String oldServerName, String newServerName, Map<DocumentRef,DocumentRef> map)

Uses of DocumentRef in org.nuxeo.ecm.core.io.impl.plugins

Method parameters in org.nuxeo.ecm.core.io.impl.plugins with type arguments of type DocumentRef

Modifier and Type	Method	Description
static DocumentsListReader	DocumentsListReader.createDocumentsListReader(CoreSession session, Collection<DocumentRef> docRefsList)

Constructors in org.nuxeo.ecm.core.io.impl.plugins with parameters of type DocumentRef

Constructor	Description
DocumentTreeReader(CoreSession session, DocumentRef root)
ExtensibleDocumentTreeReader(CoreSession session, DocumentRef root)
SingleDocumentReader(CoreSession session, DocumentRef root)
TypedSingleDocumentReader(CoreSession session, DocumentRef root)

Uses of DocumentRef in org.nuxeo.ecm.core.management.storage

Fields in org.nuxeo.ecm.core.management.storage declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	DocumentStoreManager.rootletRef

Methods in org.nuxeo.ecm.core.management.storage that return DocumentRef

Modifier and Type	Method	Description
protected DocumentRef	DocumentStoreManager.setupRootlet(CoreSession session)

Methods in org.nuxeo.ecm.core.management.storage with parameters of type DocumentRef

Modifier and Type	Method	Description
void	DocumentStoreHandler.onStorageInitialization(CoreSession session, DocumentRef rootletRef)

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

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

Modifier and Type	Method	Description
protected boolean	DocumentModelResolver.hasReadPermission(CoreSession session, DocumentRef docRef)	Checks directly the Read permission as CoreSession.exists(DocumentRef) relies on the Browse permission only.

Method parameters in org.nuxeo.ecm.core.model with type arguments of type DocumentRef

Modifier and Type	Method	Description
protected void	DocumentModelResolver.resolve(Object value, Object context, BiConsumer<CoreSession,DocumentRef> resolver)	Resolves the value (in the context) into a session and docRef, and passes them to the resolver.

Uses of DocumentRef in org.nuxeo.ecm.core.opencmis.impl.server

Methods in org.nuxeo.ecm.core.opencmis.impl.server with parameters of type DocumentRef

Modifier and Type	Method	Description
protected String	NuxeoCmisService.getIdFromDocumentRef(DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.core.rest

Methods in org.nuxeo.ecm.core.rest with parameters of type DocumentRef

Modifier and Type	Method	Description
static DocumentObject	DocumentFactory.newDocument(WebContext ctx, DocumentRef ref)
DocumentObject	DocumentObject.newDocument(DocumentRef ref)
static DocumentObject	DocumentFactory.newDocumentRoot(WebContext ctx, DocumentRef ref)

Constructors in org.nuxeo.ecm.core.rest with parameters of type DocumentRef

Constructor	Description
DocumentRoot(WebContext ctx, DocumentRef root)

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

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

Modifier and Type	Method	Description
protected void	RetentionExpiredAction.RetentionExpiredComputation.sendEvent(CoreSession session, DocumentRef ref, Calendar retainUntil)

Method parameters in org.nuxeo.ecm.core.security with type arguments of type DocumentRef

Modifier and Type	Method	Description
protected void	UpdateACEStatusWork.fireACEStatusUpdatedEvent(Map<DocumentRef,List<ACE>> refToACEs)

Uses of DocumentRef in org.nuxeo.ecm.core.storage

Fields in org.nuxeo.ecm.core.storage with type parameters of type DocumentRef

Modifier and Type	Field	Description
protected List<DocumentRef>	FulltextExtractorWork.docsToUpdate

Uses of DocumentRef in org.nuxeo.ecm.core.trash

Fields in org.nuxeo.ecm.core.trash with type parameters of type DocumentRef

Modifier and Type	Field	Description
Set<DocumentRef>	TrashInfo.rootParentRefs	Refs of parents of common tree roots of docs found ok.
List<DocumentRef>	TrashInfo.rootRefs	Refs of common tree roots of docs found ok.

Methods in org.nuxeo.ecm.core.trash that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
protected Set<DocumentRef>	PropertyTrashService.doUntrashDocument(DocumentModel doc, boolean processChildren)
protected Set<DocumentRef>	LifeCycleTrashService.undeleteDocumentList(CoreSession session, List<DocumentModel> docs)	Deprecated. Undeletes a list of documents.
Set<DocumentRef>	BridgeTrashService.undeleteDocuments(List<DocumentModel> docs)
Set<DocumentRef>	LifeCycleTrashService.undeleteDocuments(List<DocumentModel> docs)	Deprecated.
Set<DocumentRef>	PropertyTrashService.undeleteDocuments(List<DocumentModel> docs)
Set<DocumentRef>	TrashService.undeleteDocuments(List<DocumentModel> docs)	Deprecated. since 10.1 use TrashService.untrashDocuments(List) instead

Methods in org.nuxeo.ecm.core.trash with parameters of type DocumentRef

Modifier and Type	Method	Description
boolean	BridgeTrashService.isTrashed(CoreSession session, DocumentRef doc)
boolean	LifeCycleTrashService.isTrashed(CoreSession session, DocumentRef docRef)	Deprecated.
boolean	PropertyTrashService.isTrashed(CoreSession session, DocumentRef docRef)
protected void	LifeCycleTrashService.undeleteAncestors(CoreSession session, DocumentRef docRef, Set<DocumentRef> undeleted)	Deprecated. Undeletes ancestors of a document.
String	AbstractTrashService.unmangleName(CoreSession session, DocumentRef parentRef, String docName)

Method parameters in org.nuxeo.ecm.core.trash with type arguments of type DocumentRef

Modifier and Type	Method	Description
void	AbstractTrashService.purgeDocuments(CoreSession session, List<DocumentRef> docRefs)
protected void	LifeCycleTrashService.undeleteAncestors(CoreSession session, DocumentRef docRef, Set<DocumentRef> undeleted)	Deprecated. Undeletes ancestors of a document.

Uses of DocumentRef in org.nuxeo.ecm.csv.core

Methods in org.nuxeo.ecm.csv.core with parameters of type DocumentRef

Modifier and Type	Method	Description
void	CSVImporterDocumentFactory.updateDocument(CoreSession session, DocumentRef docRef, Map<String,Serializable> values)
protected boolean	CSVImporterWork.updateDocument(long lineNumber, DocumentRef docRef, Map<String,Serializable> properties)
void	DefaultCSVImporterDocumentFactory.updateDocument(CoreSession session, DocumentRef docRef, Map<String,Serializable> values)

Uses of DocumentRef in org.nuxeo.ecm.directory.localconfiguration

Fields in org.nuxeo.ecm.directory.localconfiguration declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	DirectoryConfigurationAdapter.documentRef

Methods in org.nuxeo.ecm.directory.localconfiguration that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	DirectoryConfigurationAdapter.getDocumentRef()

Uses of DocumentRef in org.nuxeo.ecm.localconf

Methods in org.nuxeo.ecm.localconf that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	SimpleConfigurationAdapter.getDocumentRef()

Uses of DocumentRef in org.nuxeo.ecm.permissions.operations

Methods in org.nuxeo.ecm.permissions.operations with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentModel	SendNotificationEmailForPermission.run(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.audit.api

Methods in org.nuxeo.ecm.platform.audit.api with parameters of type DocumentRef

Modifier and Type	Method	Description
void	LogEntry.setDocUUID(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.audit.api.comment

Fields in org.nuxeo.ecm.platform.audit.api.comment declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	LinkedDocument.documentRef

Methods in org.nuxeo.ecm.platform.audit.api.comment that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	LinkedDocument.getDocumentRef()

Methods in org.nuxeo.ecm.platform.audit.api.comment with parameters of type DocumentRef

Modifier and Type	Method	Description
void	LinkedDocument.setDocumentRef(DocumentRef documentRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.audit.impl

Methods in org.nuxeo.ecm.platform.audit.impl with parameters of type DocumentRef

Modifier and Type	Method	Description
void	LogEntryImpl.setDocUUID(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.audit.io

Methods in org.nuxeo.ecm.platform.audit.io that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
Map<DocumentRef,List<LogEntry>>	IOAuditResources.getLogsMap()

Methods in org.nuxeo.ecm.platform.audit.io with parameters of type DocumentRef

Modifier and Type	Method	Description
List<LogEntry>	IOAuditResources.getDocumentLogs(DocumentRef docRef)
static List<LogEntry>	IOLogEntryBase.translate(List<LogEntry> docLogs, DocumentRef newRef)

Method parameters in org.nuxeo.ecm.platform.audit.io with type arguments of type DocumentRef

Modifier and Type	Method	Description
IOResources	IOAuditAdapter.extractResources(String repo, Collection<DocumentRef> sources)	Extract logs involving given documents.

Constructor parameters in org.nuxeo.ecm.platform.audit.io with type arguments of type DocumentRef

Constructor	Description
IOAuditResources(Map<DocumentRef,List<LogEntry>> docLogs)

Uses of DocumentRef in org.nuxeo.ecm.platform.audit.service

Methods in org.nuxeo.ecm.platform.audit.service with parameters of type DocumentRef

Modifier and Type	Method	Description
protected DocumentModel	AbstractAuditBackend.guardedDocument(CoreSession session, DocumentRef reference)
protected DocumentModelList	AbstractAuditBackend.guardedDocumentChildren(CoreSession session, DocumentRef reference)

Uses of DocumentRef in org.nuxeo.ecm.platform.comment.api

Methods in org.nuxeo.ecm.platform.comment.api that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	CommentManager.getTopLevelDocumentRef(CoreSession session, DocumentRef commentRef)	Gets the top level ancestor document ref for the given document model comment ref.

Methods in org.nuxeo.ecm.platform.comment.api with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentRef	CommentManager.getTopLevelDocumentRef(CoreSession session, DocumentRef commentRef)	Gets the top level ancestor document ref for the given document model comment ref.

Uses of DocumentRef in org.nuxeo.ecm.platform.comment.impl

Methods in org.nuxeo.ecm.platform.comment.impl that return DocumentRef

Modifier and Type	Method	Description
protected DocumentRef	PropertyCommentManager.getAncestorRef(CoreSession session, DocumentModel documentModel)	Deprecated.
protected DocumentRef	TreeCommentManager.getLocationRefOfCommentCreation(CoreSession session, DocumentModel commentedDoc)	Returns the DocumentRef of the comments location in repository for the given commented document model.
DocumentRef	AbstractCommentManager.getTopLevelDocumentRef(CoreSession session, DocumentRef commentRef)
DocumentRef	BridgeCommentManager.getTopLevelDocumentRef(CoreSession session, DocumentRef commentIdRef)

Methods in org.nuxeo.ecm.platform.comment.impl with parameters of type DocumentRef

Modifier and Type	Method	Description
protected void	TreeCommentManager.checkCreateCommentPermissions(CoreSession session, DocumentRef documentRef)	Checks if the user related to the session can comments the document linked to the documentRef.
protected <T> T	BridgeCommentManager.execute(CoreSession s, DocumentRef documentRef, Function<CommentManager,T> function)	Executes the given function for a comment document ref, depending on the types of comment managers.
DocumentRef	AbstractCommentManager.getTopLevelDocumentRef(CoreSession session, DocumentRef commentRef)
DocumentRef	BridgeCommentManager.getTopLevelDocumentRef(CoreSession session, DocumentRef commentIdRef)
protected void	TreeCommentManager.removeComment(CoreSession session, DocumentRef documentRef)	Remove the comment of the given documentRef

Uses of DocumentRef in org.nuxeo.ecm.platform.comment.workflow

Methods in org.nuxeo.ecm.platform.comment.workflow with parameters of type DocumentRef

Modifier and Type	Method	Description
protected void	ModerateCommentOperation.moderate(DocumentRef docRef)
DocumentModel	ModerateCommentOperation.run(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.comment.workflow.utils

Fields in org.nuxeo.ecm.platform.comment.workflow.utils declared as DocumentRef

Modifier and Type	Field	Description
DocumentRef	FollowTransitionUnrestricted.docRef

Constructors in org.nuxeo.ecm.platform.comment.workflow.utils with parameters of type DocumentRef

Constructor	Description
FollowTransitionUnrestricted(CoreSession session, DocumentRef docRef, String transition)

Uses of DocumentRef in org.nuxeo.ecm.platform.content.template.factories

Methods in org.nuxeo.ecm.platform.content.template.factories with parameters of type DocumentRef

Modifier and Type	Method	Description
protected void	SimpleTemplateBasedFactory.setAcl(List<ACEDescriptor> aces, DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.platform.dublincore.listener

Constructors in org.nuxeo.ecm.platform.dublincore.listener with parameters of type DocumentRef

Constructor	Description
UnrestrictedPropertySetter(CoreSession session, DocumentRef docRef, String xpath, Serializable value)

Uses of DocumentRef in org.nuxeo.ecm.platform.io.api

Methods in org.nuxeo.ecm.platform.io.api that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
Collection<DocumentRef>	IOManager.copyDocumentsAndResources(String repo, Collection<DocumentRef> sources, DocumentLocation targetLocation, Collection<String> ioAdapters)	Copy documents and resources to another location (on a same machine).

Methods in org.nuxeo.ecm.platform.io.api with parameters of type DocumentRef

Modifier and Type	Method	Description
void	IOManager.importDocumentsAndResources(InputStream in, String repo, DocumentRef root)	Import document and resources described by given input stream at given document location.

Method parameters in org.nuxeo.ecm.platform.io.api with type arguments of type DocumentRef

Modifier and Type	Method	Description
Collection<DocumentRef>	IOManager.copyDocumentsAndResources(String repo, Collection<DocumentRef> sources, DocumentLocation targetLocation, Collection<String> ioAdapters)	Copy documents and resources to another location (on a same machine).
void	IOManager.exportDocumentsAndResources(OutputStream out, String repo, Collection<DocumentRef> sources, boolean recurse, String format, Collection<String> ioAdapters)	Export documents and resources.
abstract IOResources	AbstractIOResourceAdapter.extractResources(String repo, Collection<DocumentRef> sources)
IOResources	IOResourceAdapter.extractResources(String repo, Collection<DocumentRef> sources)	Extracts resources for given document locations.

Uses of DocumentRef in org.nuxeo.ecm.platform.io.impl

Methods in org.nuxeo.ecm.platform.io.impl that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
Collection<DocumentRef>	IOManagerImpl.copyDocumentsAndResources(String repo, Collection<DocumentRef> sources, DocumentLocation targetLocation, Collection<String> ioAdapters)

Methods in org.nuxeo.ecm.platform.io.impl with parameters of type DocumentRef

Modifier and Type	Method	Description
void	IOManagerImpl.importDocumentsAndResources(InputStream in, String repo, DocumentRef root)
void	IOManagerImpl.importDocumentsAndResources(InputStream in, String repo, DocumentRef root, DocumentWriter customDocWriter)

Method parameters in org.nuxeo.ecm.platform.io.impl with type arguments of type DocumentRef

Modifier and Type	Method	Description
Collection<DocumentRef>	IOManagerImpl.copyDocumentsAndResources(String repo, Collection<DocumentRef> sources, DocumentLocation targetLocation, Collection<String> ioAdapters)
void	IOManagerImpl.exportDocumentsAndResources(OutputStream out, String repo, Collection<DocumentRef> sources, boolean recurse, String format, Collection<String> ioAdapters)

Uses of DocumentRef in org.nuxeo.ecm.platform.picture.operation

Methods in org.nuxeo.ecm.platform.picture.operation with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentModel	CreatePicture.run(DocumentRef doc)

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.api

Methods in org.nuxeo.ecm.platform.publisher.api that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	PublishedDocument.getSourceDocumentRef()

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.impl.core

Methods in org.nuxeo.ecm.platform.publisher.impl.core that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	SimpleCorePublishedDocument.getSourceDocumentRef()
DocumentRef	CoreFolderPublicationNode.getTargetDocumentRef()

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.rules

Fields in org.nuxeo.ecm.platform.publisher.rules declared as DocumentRef

Modifier and Type	Field	Description
DocumentRef	DefaultValidatorsRule.UnrestrictedACPGetter.docRef

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.task

Fields in org.nuxeo.ecm.platform.publisher.task declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	CoreProxyWithWorkflowFactory.DocumentPublisherUnrestricted.docRef
protected DocumentRef	CoreProxyWithWorkflowFactory.DocumentPublisherUnrestricted.targetRef

Constructors in org.nuxeo.ecm.platform.publisher.task with parameters of type DocumentRef

Constructor	Description
DocumentPublisherUnrestricted(CoreSession session, DocumentRef docRef, DocumentRef targetRef, NuxeoPrincipal principal, String comment)

Uses of DocumentRef in org.nuxeo.ecm.platform.relations.io

Methods in org.nuxeo.ecm.platform.relations.io that return DocumentRef

Modifier and Type	Method	Description
protected DocumentRef	IORelationAdapter.getDocumentRef(RelationManager relManager, QNameResource resource)

Methods in org.nuxeo.ecm.platform.relations.io that return types with arguments of type DocumentRef

Modifier and Type	Method	Description
Map<DocumentRef,Set<Resource>>	IORelationResources.getResourcesMap()

Methods in org.nuxeo.ecm.platform.relations.io with parameters of type DocumentRef

Modifier and Type	Method	Description
Set<Resource>	IORelationResources.getDocumentResources(DocumentRef docRef)

Method parameters in org.nuxeo.ecm.platform.relations.io with type arguments of type DocumentRef

Modifier and Type	Method	Description
IOResources	IORelationAdapter.extractResources(String repo, Collection<DocumentRef> sources)	Extract relations involving given documents.

Uses of DocumentRef in org.nuxeo.ecm.platform.rendition.lazy

Fields in org.nuxeo.ecm.platform.rendition.lazy declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	AbstractRenditionBuilderWork.docRef

Uses of DocumentRef in org.nuxeo.ecm.platform.rendition.publisher

Fields in org.nuxeo.ecm.platform.rendition.publisher declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	RenditionPublicationFactory.RemoveACP.docRef

Methods in org.nuxeo.ecm.platform.rendition.publisher with parameters of type DocumentRef

Modifier and Type	Method	Description
protected List<PublishedDocument>	RenditionPublicationCoreTree.getPublishedDocumentsFromLiveDocument(DocumentRef docRef)
protected List<PublishedDocument>	RenditionPublicationCoreTree.getPublishedDocumentsFromProxyDocument(DocumentRef docRef, DocumentModel sourceDocument)

Constructors in org.nuxeo.ecm.platform.rendition.publisher with parameters of type DocumentRef

Constructor	Description
RemoveACP(CoreSession session, DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.rendition.service

Methods in org.nuxeo.ecm.platform.rendition.service that return DocumentRef

Modifier and Type	Method	Description
protected DocumentRef	RenditionServiceImpl.createVersionIfNeeded(DocumentModel source, CoreSession session)
DocumentRef	RenditionService.storeRendition(DocumentModel sourceDocument, String renditionDefinitionName)	Render a document based on the given rendition definition name and returns the stored Rendition DocumentRef.
DocumentRef	RenditionServiceImpl.storeRendition(DocumentModel source, String renditionDefinitionName)

Uses of DocumentRef in org.nuxeo.ecm.platform.routing.api

Methods in org.nuxeo.ecm.platform.routing.api with parameters of type DocumentRef

Modifier and Type	Method	Description
void	DocumentRoutingService.addRouteElementToRoute(DocumentRef parentDocumentRef, int idx, DocumentRouteElement routeElement, CoreSession session)	Deprecated. since 5.9.2 - Use only routes of type 'graph'
void	DocumentRoutingService.addRouteElementToRoute(DocumentRef parentDocumentRef, String sourceName, DocumentRouteElement routeElement, CoreSession session)	Deprecated. since 5.9.2 - Use only routes of type 'graph'

Uses of DocumentRef in org.nuxeo.ecm.platform.routing.core.impl

Fields in org.nuxeo.ecm.platform.routing.core.impl declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	DocumentRouteElementImpl.SetDocumentOnReadOnlyUnrestrictedSessionRunner.ref

Methods in org.nuxeo.ecm.platform.routing.core.impl with parameters of type DocumentRef

Modifier and Type	Method	Description
void	DocumentRoutingServiceImpl.addRouteElementToRoute(DocumentRef parentDocumentRef, int idx, DocumentRouteElement routeElement, CoreSession session)	Deprecated.
void	DocumentRoutingServiceImpl.addRouteElementToRoute(DocumentRef parentDocumentRef, String sourceName, DocumentRouteElement routeElement, CoreSession session)	Deprecated.

Constructors in org.nuxeo.ecm.platform.routing.core.impl with parameters of type DocumentRef

Constructor	Description
SetDocumentOnReadOnlyUnrestrictedSessionRunner(CoreSession session, DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.platform.task.dashboard

Methods in org.nuxeo.ecm.platform.task.dashboard that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	DashBoardItem.getDocRef()	Returns the document reference on which the item is bound.
DocumentRef	DashBoardItemImpl.getDocRef()

Uses of DocumentRef in org.nuxeo.ecm.platform.types.localconfiguration

Fields in org.nuxeo.ecm.platform.types.localconfiguration declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	ContentViewConfigurationAdapter.documentRef
protected DocumentRef	UITypesConfigurationAdapter.documentRef

Methods in org.nuxeo.ecm.platform.types.localconfiguration that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	ContentViewConfigurationAdapter.getDocumentRef()
DocumentRef	UITypesConfigurationAdapter.getDocumentRef()

Uses of DocumentRef in org.nuxeo.ecm.quota.automation

Fields in org.nuxeo.ecm.quota.automation declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	GetQuotaInfoOperation.documentRef
protected DocumentRef	GetQuotaStatisticsOperation.documentRef
protected DocumentRef	SetQuotaInfoOperation.documentRef

Methods in org.nuxeo.ecm.quota.automation with parameters of type DocumentRef

Modifier and Type	Method	Description
JsonAdapter	GetQuotaInfoOperation.run(DocumentRef docRef)
Long	SetQuotaInfoOperation.run(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.restapi.server.jaxrs

Methods in org.nuxeo.ecm.restapi.server.jaxrs with parameters of type DocumentRef

Modifier and Type	Method	Description
DocumentObject	JSONDocumentObject.newDocument(DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.webdav.backend

Methods in org.nuxeo.ecm.webdav.backend with parameters of type DocumentRef

Modifier and Type	Method	Description
boolean	AbstractVirtualBackend.canUnlock(DocumentRef ref)
boolean	Backend.canUnlock(DocumentRef ref)
boolean	SimpleBackend.canUnlock(DocumentRef ref)
protected boolean	SimpleBackend.cleanTrashPath(DocumentRef parentRef, String name)
String	AbstractVirtualBackend.getCheckoutUser(DocumentRef ref)
String	Backend.getCheckoutUser(DocumentRef ref)
String	SimpleBackend.getCheckoutUser(DocumentRef ref)
List<DocumentModel>	AbstractVirtualBackend.getChildren(DocumentRef ref)
List<DocumentModel>	Backend.getChildren(DocumentRef ref)
List<DocumentModel>	SimpleBackend.getChildren(DocumentRef ref)
boolean	AbstractVirtualBackend.hasPermission(DocumentRef docRef, String permission)
boolean	Backend.hasPermission(DocumentRef docRef, String permission)
boolean	SimpleBackend.hasPermission(DocumentRef docRef, String permission)
boolean	AbstractVirtualBackend.isLocked(DocumentRef ref)
boolean	Backend.isLocked(DocumentRef ref)
boolean	SimpleBackend.isLocked(DocumentRef ref)
String	AbstractVirtualBackend.lock(DocumentRef ref)
String	Backend.lock(DocumentRef ref)
String	SimpleBackend.lock(DocumentRef ref)
DocumentModel	AbstractVirtualBackend.moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
DocumentModel	Backend.moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
DocumentModel	SimpleBackend.moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
void	AbstractVirtualBackend.removeItem(DocumentRef ref)
void	Backend.removeItem(DocumentRef ref)
void	SimpleBackend.removeItem(DocumentRef ref)
boolean	AbstractVirtualBackend.unlock(DocumentRef ref)
boolean	Backend.unlock(DocumentRef ref)
boolean	SimpleBackend.unlock(DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.webengine.util

Methods in org.nuxeo.ecm.webengine.util with parameters of type DocumentRef

Modifier and Type	Method	Description
static void	ACLUtils.removePermission(CoreSession session, DocumentRef docRef, String username, String permission)

Uses of DocumentRef in org.nuxeo.snapshot

Methods in org.nuxeo.snapshot that return DocumentRef

Modifier and Type	Method	Description
protected DocumentRef	SnapshotableAdapter.createLeafVersion(DocumentModel targetDoc, VersioningOption option)
DocumentRef	Snapshot.getRef()
DocumentRef	SnapshotableAdapter.getRef()

Uses of DocumentRef in org.nuxeo.template.adapters.doc

Methods in org.nuxeo.template.adapters.doc that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	TemplateBasedDocumentAdapterImpl.getSourceTemplateDocRef(String templateName)

Uses of DocumentRef in org.nuxeo.template.api.adapters

Methods in org.nuxeo.template.api.adapters that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	TemplateBasedDocument.getSourceTemplateDocRef(String templateName)	Retrieve the Template DocumentRef for a given template name

Uses of DocumentRef in org.nuxeo.template.service

Fields in org.nuxeo.template.service declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	TemplateMappingRemover.targetRef

Uses of DocumentRef in org.nuxeo.theme.localconfiguration

Fields in org.nuxeo.theme.localconfiguration declared as DocumentRef

Modifier and Type	Field	Description
protected DocumentRef	LocalThemeConfigAdapter.documentRef

Methods in org.nuxeo.theme.localconfiguration that return DocumentRef

Modifier and Type	Method	Description
DocumentRef	LocalThemeConfigAdapter.getDocumentRef()