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

Packages that use DocumentRef

Package	Description
org.nuxeo.ecm.admin.repo
org.nuxeo.ecm.automation.core.collectors
org.nuxeo.ecm.automation.core.impl.adapters
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.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.rest
org.nuxeo.ecm.core.trash
org.nuxeo.ecm.csv
org.nuxeo.ecm.directory.localconfiguration
org.nuxeo.ecm.localconf
org.nuxeo.ecm.mobile.webengine
org.nuxeo.ecm.mobile.webengine.document
org.nuxeo.ecm.platform.annotations.repository
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.categorization.service
org.nuxeo.ecm.platform.comment.workflow
org.nuxeo.ecm.platform.comment.workflow.utils
org.nuxeo.ecm.platform.faceted.search.jsf.localconfiguration
org.nuxeo.ecm.platform.io.api
org.nuxeo.ecm.platform.io.impl
org.nuxeo.ecm.platform.picture.operation
org.nuxeo.ecm.platform.preview.helper
org.nuxeo.ecm.platform.publisher.api
org.nuxeo.ecm.platform.publisher.impl.core
org.nuxeo.ecm.platform.publisher.impl.localfs
org.nuxeo.ecm.platform.publisher.remoting.marshaling
org.nuxeo.ecm.platform.publisher.remoting.marshaling.basic
org.nuxeo.ecm.platform.publisher.remoting.server
org.nuxeo.ecm.platform.relations.io
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.platform.ui.web.api
org.nuxeo.ecm.platform.ui.web.cache
org.nuxeo.ecm.platform.ui.web.component.document
org.nuxeo.ecm.platform.ui.web.util
org.nuxeo.ecm.quota.automation
org.nuxeo.ecm.restapi.server.jaxrs
org.nuxeo.ecm.social.workspace.listeners
org.nuxeo.ecm.social.workspace.service
org.nuxeo.ecm.user.center.dashboard
org.nuxeo.ecm.webapp.clipboard
org.nuxeo.ecm.webapp.context
org.nuxeo.ecm.webapp.helpers
org.nuxeo.ecm.webapp.localconfiguration.search
org.nuxeo.ecm.webdav.backend
org.nuxeo.ecm.webengine.util
org.nuxeo.search.ui.localconfiguration
org.nuxeo.snapshot
org.nuxeo.template.adapters.doc
org.nuxeo.template.api.adapters
org.nuxeo.theme.localconfiguration

Uses of DocumentRef in org.nuxeo.ecm.admin.repo

Methods in org.nuxeo.ecm.admin.repo with parameters of type DocumentRef

Modifier and Type	Method and Description
void	RepoStat.run(DocumentRef root)

Constructors in org.nuxeo.ecm.admin.repo with parameters of type DocumentRef

Constructor and Description
StatsTask(String repoName, DocumentRef rootDocRef, boolean includeBlob, RepoStat instance)
StatsTaskRunner(String repositoryName, boolean includeBlob, DocumentRef rootref, StatsTask hostTask)

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 and 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 and Description
static DocumentRef	StringToDocRef.createRef(String value)
static DocumentRef	StringToDocModel.createRef(String value)
DocumentRef	ArrayStringToDocModelList.createRef(String value)
DocumentRef	StringToDocRef.getAdaptedValue(OperationContext ctx, Object objectToAdapt)

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

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

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

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 and Description
DocumentRef	PushDocument.run(DocumentRef doc)

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

Modifier and Type	Method and 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 and 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 and Description
static DocumentRef	DocumentInputResolver.docRefFromString(String input)
DocumentRef	DocumentInputResolver.getInput(String content)

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

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

Modifier and Type	Class and Description
class	IdRef An ID reference to a document.
class	PathRef A PATH reference to a document.

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

Modifier and Type	Method and Description
DocumentRef	CoreSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment) Checks in a modified document, creating a new version.
DocumentRef	AbstractSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment)
DocumentRef	DocumentModel.checkIn(VersioningOption option, String checkinComment) Checks in a document and returns the created version.
DocumentRef	CoreSession.getBaseVersion(DocumentRef docRef) Gets the version to which a checked in document is linked.
DocumentRef	AbstractSession.getBaseVersion(DocumentRef docRef)
DocumentRef	DocumentLocation.getDocRef() Returns the document reference.
DocumentRef	CoreSession.getLastDocumentVersionRef(DocumentRef docRef) Gets the document reference corresponding to the last version for the given document.
DocumentRef	AbstractSession.getLastDocumentVersionRef(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.getParentDocumentRef(DocumentRef docRef)
DocumentRef[]	CoreSession.getParentDocumentRefs(DocumentRef docRef) Creates an array with all parent refs starting from the given document up to the root.
DocumentRef[]	AbstractSession.getParentDocumentRefs(DocumentRef docRef)
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 and Description
List<DocumentRef>	CoreSession.getChildrenRefs(DocumentRef parentRef, String perm) Gets the references of the children.
List<DocumentRef>	AbstractSession.getChildrenRefs(DocumentRef parentRef, String perm)
List<DocumentRef>	CoreSession.getVersionsRefs(DocumentRef docRef) Gets the references of the versions of the document.
List<DocumentRef>	AbstractSession.getVersionsRefs(DocumentRef docRef)

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

Modifier and Type	Method and Description
<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.
<T extends DetachedAdapter> T	AbstractSession.adaptFirstMatchingDocumentWithFacet(DocumentRef docRef, String facet, Class<T> adapterClass)
boolean	CoreSession.canRemoveDocument(DocumentRef docRef) Check if a document can be removed.
boolean	AbstractSession.canRemoveDocument(DocumentRef docRef)
DocumentRef	CoreSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment) Checks in a modified document, creating a new version.
DocumentRef	AbstractSession.checkIn(DocumentRef docRef, VersioningOption option, String checkinComment)
DocumentModel	CoreSession.checkIn(DocumentRef docRef, VersionModel version) Deprecated. use CoreSession.checkIn(DocumentRef, VersioningOption, String) instead
DocumentModel	AbstractSession.checkIn(DocumentRef docRef, VersionModel ver) Deprecated.
void	CoreSession.checkOut(DocumentRef docRef) Checks out a versioned document.
void	AbstractSession.checkOut(DocumentRef docRef)
DocumentModel	CoreSession.copy(DocumentRef src, DocumentRef dst, String name) Copies the source document to the destination folder under the given name.
DocumentModel	AbstractSession.copy(DocumentRef src, DocumentRef dst, String name)
DocumentModel	CoreSession.copy(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle) Copies the source document to the destination folder under the given name.
DocumentModel	AbstractSession.copy(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle)
List<DocumentModel>	CoreSession.copy(List<DocumentRef> src, DocumentRef dst) Bulk copy.
List<DocumentModel>	AbstractSession.copy(List<DocumentRef> src, DocumentRef dst)
List<DocumentModel>	CoreSession.copy(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle) Bulk copy.
List<DocumentModel>	AbstractSession.copy(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)
DocumentModel	CoreSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name) Work like copy but in the case of a source proxy the destination will be a new document instead of a proxy.
DocumentModel	AbstractSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name)
DocumentModel	CoreSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle) Work like copy but in the case of a source proxy the destination will be a new document instead of a proxy.
DocumentModel	AbstractSession.copyProxyAsDocument(DocumentRef src, DocumentRef dst, String name, boolean resetLifeCycle)
List<DocumentModel>	CoreSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst) Bulk copyProxyAsDocument.
List<DocumentModel>	AbstractSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst)
List<DocumentModel>	CoreSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle) Bulk copyProxyAsDocument.
List<DocumentModel>	AbstractSession.copyProxyAsDocument(List<DocumentRef> src, DocumentRef dst, boolean resetLifeCycle)
DocumentModel	CoreSession.createProxy(DocumentRef docRef, DocumentRef folderRef) Creates a generic proxy to the given document inside the given folder.
DocumentModel	AbstractSession.createProxy(DocumentRef docRef, DocumentRef folderRef)
boolean	CoreSession.exists(DocumentRef docRef) Tests if the document pointed by the given reference exists and is accessible.
boolean	AbstractSession.exists(DocumentRef docRef)
boolean	CoreSession.followTransition(DocumentRef docRef, String transition) Follows a given life cycle transition.
boolean	AbstractSession.followTransition(DocumentRef docRef, String transition)
ACP	CoreSession.getACP(DocumentRef docRef) Gets the document access control policy.
ACP	AbstractSession.getACP(DocumentRef docRef)
Collection<String>	CoreSession.getAllowedStateTransitions(DocumentRef docRef) Gets the allowed state transitions for this document.
Collection<String>	AbstractSession.getAllowedStateTransitions(DocumentRef docRef)
DocumentRef	CoreSession.getBaseVersion(DocumentRef docRef) Gets the version to which a checked in document is linked.
DocumentRef	AbstractSession.getBaseVersion(DocumentRef docRef)
Map<String,String>	CoreSession.getBinaryFulltext(DocumentRef ref) Gets the fulltext extracted from the binary fields.
Map<String,String>	AbstractSession.getBinaryFulltext(DocumentRef ref)
DocumentModel	CoreSession.getChild(DocumentRef parent, String name) Gets a child document given its name and the parent reference.
DocumentModel	AbstractSession.getChild(DocumentRef parent, String name)
DocumentModelList	CoreSession.getChildren(DocumentRef parent) Gets the children of the given parent.
DocumentModelList	AbstractSession.getChildren(DocumentRef parent)
DocumentModelList	CoreSession.getChildren(DocumentRef parent, String type) Gets the children of the given parent filtered according to the given document type.
DocumentModelList	AbstractSession.getChildren(DocumentRef parent, String type)
DocumentModelList	CoreSession.getChildren(DocumentRef parent, String type, Filter filter, Sorter sorter) Same as CoreSession.getChildren(DocumentRef, String, String, Filter, Sorter) without specific permission filtering.
DocumentModelList	AbstractSession.getChildren(DocumentRef parent, String type, Filter filter, Sorter sorter)
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	AbstractSession.getChildren(DocumentRef parent, String type, String perm)
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	AbstractSession.getChildren(DocumentRef parent, String type, String perm, Filter filter, Sorter sorter)
DocumentModelIterator	CoreSession.getChildrenIterator(DocumentRef parent) Gets an iterator to the children of the given parent.
DocumentModelIterator	AbstractSession.getChildrenIterator(DocumentRef 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	AbstractSession.getChildrenIterator(DocumentRef parent, String 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.
DocumentModelIterator	AbstractSession.getChildrenIterator(DocumentRef parent, String type, String perm, Filter filter)
List<DocumentRef>	CoreSession.getChildrenRefs(DocumentRef parentRef, String perm) Gets the references of the children.
List<DocumentRef>	AbstractSession.getChildrenRefs(DocumentRef parentRef, String perm)
String	CoreSession.getCurrentLifeCycleState(DocumentRef docRef) Returns the life cycle of the document.
String	AbstractSession.getCurrentLifeCycleState(DocumentRef docRef)
DataModel	CoreSession.getDataModel(DocumentRef docRef, Schema schema) Retrieves a data model given a document reference and a schema.
DataModel	AbstractSession.getDataModel(DocumentRef docRef, Schema schema)
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.getDataModelsField(DocumentRef[] docRefs, 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.
Object[]	AbstractSession.getDataModelsFieldUp(DocumentRef docRef, String schema, String field)
DocumentModel	CoreSession.getDocument(DocumentRef docRef) Gets a document model given its reference.
DocumentModel	AbstractSession.getDocument(DocumentRef docRef)
DocumentModelList	CoreSession.getDocuments(DocumentRef[] docRefs) Gets a list of documents given their references.
DocumentModelList	AbstractSession.getDocuments(DocumentRef[] docRefs)
<T extends Serializable> T	CoreSession.getDocumentSystemProp(DocumentRef ref, String systemProperty, Class<T> type) Gets system property of the specified type for the document ref.
<T extends Serializable> T	AbstractSession.getDocumentSystemProp(DocumentRef ref, String systemProperty, Class<T> type)
DocumentModel	CoreSession.getDocumentWithVersion(DocumentRef docRef, VersionModel version) Returns a document that represents the specified version of the document.
DocumentModel	AbstractSession.getDocumentWithVersion(DocumentRef docRef, VersionModel version)
DocumentModelList	CoreSession.getFiles(DocumentRef parent) Same as CoreSession.getChildren(DocumentRef) but returns only non-folder documents.
DocumentModelList	AbstractSession.getFiles(DocumentRef parent)
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.
DocumentModelList	AbstractSession.getFiles(DocumentRef parent, Filter filter, Sorter sorter)
DocumentModelList	CoreSession.getFolders(DocumentRef parent) Same as CoreSession.getChildren(DocumentRef) but returns only folder documents.
DocumentModelList	AbstractSession.getFolders(DocumentRef parent)
DocumentModelList	CoreSession.getFolders(DocumentRef parent, Filter filter, Sorter sorter) Same as CoreSession.getFolders(DocumentRef) but uses an optional filter and sorter on the result.
DocumentModelList	AbstractSession.getFolders(DocumentRef parent, Filter filter, Sorter sorter)
DocumentModel	CoreSession.getLastDocumentVersion(DocumentRef docRef) Gets the document corresponding to the last version for the given document.
DocumentModel	AbstractSession.getLastDocumentVersion(DocumentRef docRef)
DocumentRef	CoreSession.getLastDocumentVersionRef(DocumentRef docRef) Gets the document reference corresponding to the last version for the given document.
DocumentRef	AbstractSession.getLastDocumentVersionRef(DocumentRef docRef)
VersionModel	CoreSession.getLastVersion(DocumentRef docRef) Deprecated. use CoreSession.getLastDocumentVersion(org.nuxeo.ecm.core.api.DocumentRef) instead
VersionModel	AbstractSession.getLastVersion(DocumentRef docRef)
String	CoreSession.getLifeCyclePolicy(DocumentRef docRef) Returns the life cycle policy of the document.
String	AbstractSession.getLifeCyclePolicy(DocumentRef docRef)
String	CoreSession.getLock(DocumentRef doc) Deprecated. since 5.4.2, use CoreSession.getLockInfo(org.nuxeo.ecm.core.api.DocumentRef) instead
String	AbstractSession.getLock(DocumentRef docRef) Deprecated.
Lock	CoreSession.getLockInfo(DocumentRef docRef) Gets the lock info on the given document.
Lock	AbstractSession.getLockInfo(DocumentRef docRef)
DocumentModel	CoreSession.getParentDocument(DocumentRef docRef) Gets the parent document or null if this is the root document.
DocumentModel	AbstractSession.getParentDocument(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.getParentDocumentRef(DocumentRef docRef)
DocumentRef[]	CoreSession.getParentDocumentRefs(DocumentRef docRef) Creates an array with all parent refs starting from the given document up to the root.
DocumentRef[]	AbstractSession.getParentDocumentRefs(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.
List<DocumentModel>	AbstractSession.getParentDocuments(DocumentRef docRef)
DocumentModelList	CoreSession.getProxies(DocumentRef docRef, DocumentRef folderRef) Finds the proxies for a document.
DocumentModelList	AbstractSession.getProxies(DocumentRef docRef, DocumentRef folderRef)
String[]	CoreSession.getProxyVersions(DocumentRef docRef, DocumentRef folderRef) Deprecated. since 5.4, use CoreSession.getProxies(org.nuxeo.ecm.core.api.DocumentRef, org.nuxeo.ecm.core.api.DocumentRef) instead
String[]	AbstractSession.getProxyVersions(DocumentRef docRef, DocumentRef folderRef)
DocumentModel	CoreSession.getSourceDocument(DocumentRef docRef) Gets the head (live) document for this document.
DocumentModel	AbstractSession.getSourceDocument(DocumentRef docRef)
List<DocumentModel>	CoreSession.getVersions(DocumentRef docRef) Retrieves all the versions for a specified document.
List<DocumentModel>	AbstractSession.getVersions(DocumentRef docRef)
String	CoreSession.getVersionSeriesId(DocumentRef docRef) Gets the version series id for a document.
String	AbstractSession.getVersionSeriesId(DocumentRef docRef)
List<VersionModel>	CoreSession.getVersionsForDocument(DocumentRef docRef) Retrieves all the versions for a specified document.
List<VersionModel>	AbstractSession.getVersionsForDocument(DocumentRef docRef)
List<DocumentRef>	CoreSession.getVersionsRefs(DocumentRef docRef) Gets the references of the versions of the document.
List<DocumentRef>	AbstractSession.getVersionsRefs(DocumentRef docRef)
DocumentModel	CoreSession.getWorkingCopy(DocumentRef docRef) Gets the working copy (live document) for a proxy or a version.
DocumentModel	AbstractSession.getWorkingCopy(DocumentRef docRef)
boolean	CoreSession.hasChildren(DocumentRef docRef) Tests if the document has any children.
boolean	AbstractSession.hasChildren(DocumentRef docRef)
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	AbstractSession.hasPermission(DocumentRef docRef, String permission)
boolean	CoreSession.hasPermission(Principal principal, DocumentRef docRef, String permission) Checks if a given principal has the given privilege on the referred document.
boolean	AbstractSession.hasPermission(Principal principal, DocumentRef docRef, String permission)
void	AbstractSession.internalCheckOut(DocumentRef docRef)
boolean	CoreSession.isCheckedOut(DocumentRef docRef) Returns whether the current document is checked-out or not.
boolean	AbstractSession.isCheckedOut(DocumentRef docRef)
boolean	CoreSession.isDirty(DocumentRef doc) Deprecated. since 5.4, use CoreSession.isCheckedOut(org.nuxeo.ecm.core.api.DocumentRef) instead
boolean	AbstractSession.isDirty(DocumentRef docRef) Deprecated.
DocumentModel	CoreSession.move(DocumentRef src, DocumentRef dst, String name) Moves the source document to the destination folder under the given name.
DocumentModel	AbstractSession.move(DocumentRef src, DocumentRef dst, String name)
void	CoreSession.move(List<DocumentRef> src, DocumentRef dst) Bulk move.
void	AbstractSession.move(List<DocumentRef> src, DocumentRef dst)
void	CoreSession.orderBefore(DocumentRef parent, String src, String dest) Given a parent document, order the source child before the destination child.
void	AbstractSession.orderBefore(DocumentRef parent, String src, String dest)
DocumentModel.DocumentModelRefresh	CoreSession.refreshDocument(DocumentRef ref, int refreshFlags, String[] schemas) Internal method - it is used internally by DocumentModel.refresh()
DocumentModel.DocumentModelRefresh	AbstractSession.refreshDocument(DocumentRef ref, int refreshFlags, String[] schemas)
void	CoreSession.reinitLifeCycleState(DocumentRef docRef) Reinitializes the life cycle state of the document to its default state.
void	AbstractSession.reinitLifeCycleState(DocumentRef docRef)
void	CoreSession.removeChildren(DocumentRef docRef) Removes all children from the given document.
void	AbstractSession.removeChildren(DocumentRef docRef)
void	CoreSession.removeDocument(DocumentRef docRef) Removes this document and all its children, if any.
void	AbstractSession.removeDocument(DocumentRef docRef)
void	CoreSession.removeDocuments(DocumentRef[] docRefs) Bulk method to remove documents.
void	AbstractSession.removeDocuments(DocumentRef[] docRefs) Implementation uses the fact that the lexicographic ordering of paths is a refinement of the "contains" partial ordering.
Lock	CoreSession.removeLock(DocumentRef docRef) Removes the lock on the given document.
Lock	AbstractSession.removeLock(DocumentRef docRef)
DocumentModel	CoreSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef) Restores the given document to the specified version.
DocumentModel	AbstractSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef)
DocumentModel	CoreSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef, boolean skipSnapshotCreation, boolean skipCheckout) Restores the given document to the specified version.
DocumentModel	AbstractSession.restoreToVersion(DocumentRef docRef, DocumentRef versionRef, boolean skipSnapshotCreation, boolean skipCheckout)
DocumentModel	CoreSession.restoreToVersion(DocumentRef docRef, VersionModel version) Deprecated. use CoreSession.restoreToVersion(DocumentRef, DocumentRef) instead
DocumentModel	AbstractSession.restoreToVersion(DocumentRef docRef, VersionModel version) Deprecated.
DocumentModel	CoreSession.restoreToVersion(DocumentRef docRef, VersionModel version, boolean skipSnapshotCreation) Deprecated. use CoreSession.restoreToVersion(DocumentRef, DocumentRef, boolean, boolean) instead
DocumentModel	AbstractSession.restoreToVersion(DocumentRef docRef, VersionModel version, boolean skipSnapshotCreation) Deprecated.
void	CoreSession.setACP(DocumentRef docRef, ACP acp, boolean overwrite) Sets the ACP for this document.
void	AbstractSession.setACP(DocumentRef docRef, ACP newAcp, boolean overwrite)
<T extends Serializable> void	CoreSession.setDocumentSystemProp(DocumentRef ref, String systemProperty, T value) Sets given value as a system property.
<T extends Serializable> void	AbstractSession.setDocumentSystemProp(DocumentRef ref, String systemProperty, T value)
Lock	CoreSession.setLock(DocumentRef docRef) Sets a lock on the given document.
Lock	AbstractSession.setLock(DocumentRef docRef)
void	CoreSession.setLock(DocumentRef doc, String key) Deprecated. since 5.4.2, use CoreSession.setLock(DocumentRef) instead
void	AbstractSession.setLock(DocumentRef docRef, String key) Deprecated.
String	CoreSession.unlock(DocumentRef docRef) Deprecated. since 5.4.2, use CoreSession.removeLock(org.nuxeo.ecm.core.api.DocumentRef) instead
String	AbstractSession.unlock(DocumentRef docRef) Deprecated.

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

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

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

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

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

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

Constructor and 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)
DocumentModelImpl(String sid, String type, String id, Path path, Lock lock, DocumentRef docRef, DocumentRef parentRef, String[] schemas, Set<String> facets, String sourceId, String repositoryName) Constructor.

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

Constructor and 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 and Description
DocumentRef	LocalConfiguration.getDocumentRef() Returns the related DocumentRef of this local configuration.

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 and 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 and Description
DocumentEventContext(CoreSession session, Principal 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 and 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 and 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 and 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 and 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 and 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 and 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 and 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 and 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 and Description
DocumentChildrenReader(CoreSession session, DocumentRef root) Deprecated.
DocumentTreeReader(CoreSession session, DocumentRef root)
SingleDocumentReader(CoreSession session, DocumentRef root)
TypedSingleDocumentReader(CoreSession session, DocumentRef root)

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

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

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

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 and Description
DocumentObject	DocumentObject.newDocument(DocumentRef ref)
static DocumentObject	DocumentFactory.newDocument(WebContext ctx, DocumentRef ref)
static DocumentObject	DocumentFactory.newDocumentRoot(WebContext ctx, DocumentRef ref)

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

Constructor and Description
DocumentRoot(WebContext ctx, DocumentRef root)

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 and 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 and Description
Set<DocumentRef>	TrashServiceImpl.undeleteDocuments(List<DocumentModel> docs)
Set<DocumentRef>	TrashService.undeleteDocuments(List<DocumentModel> docs) Undeletes documents (and ancestors if needed to make them visible).

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

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

Uses of DocumentRef in org.nuxeo.ecm.csv

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

Modifier and Type	Method and Description
void	DefaultCSVImporterDocumentFactory.updateDocument(CoreSession session, DocumentRef docRef, Map<String,Serializable> values)
void	CSVImporterDocumentFactory.updateDocument(CoreSession session, DocumentRef docRef, Map<String,Serializable> values)

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

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

Modifier and Type	Method and 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 and Description
DocumentRef	SimpleConfigurationAdapter.getDocumentRef()

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

Methods in org.nuxeo.ecm.mobile.webengine that return DocumentRef

Modifier and Type	Method and Description
static DocumentRef	RedirectHelper.findDocumentRef(String targetURL)

Uses of DocumentRef in org.nuxeo.ecm.mobile.webengine.document

Constructors in org.nuxeo.ecm.mobile.webengine.document with parameters of type DocumentRef

Constructor and Description
MobileDocument(WebContext ctx, DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.annotations.repository

Methods in org.nuxeo.ecm.platform.annotations.repository that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	DefaultNuxeoUriResolver.getDocumentRef(URI uri)

Methods in org.nuxeo.ecm.platform.annotations.repository with parameters of type DocumentRef

Modifier and Type	Method and Description
URI	URNDocumentViewTranslator.getUriFromDocumentView(String serverName, 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 and Description
void	LogEntry.setDocUUID(DocumentRef docRef)

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

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

Modifier and Type	Method and Description
DocumentRef	LinkedDocument.getDocumentRef()

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

Modifier and Type	Method and 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 and 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 and Description
Map<DocumentRef,List<LogEntry>>	IOAuditResources.getLogsMap()

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

Modifier and Type	Method and 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 and 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 and Description
IOAuditResources(Map<DocumentRef,List<LogEntry>> docLogs)

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

Method parameters in org.nuxeo.ecm.platform.categorization.service with type arguments of type DocumentRef

Modifier and Type	Method and Description
List<DocumentModel>	DocumentCategorizationServiceImpl.updateCategories(CoreSession session, List<DocumentRef> docRefs)
List<DocumentModel>	DocumentCategorizationService.updateCategories(CoreSession session, List<DocumentRef> docRefs) Run all registered document categorizers on the given documents fetched using the provided session.

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 and Description
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 and Description
DocumentRef	FollowTransitionUnrestricted.docRef

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

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

Uses of DocumentRef in org.nuxeo.ecm.platform.faceted.search.jsf.localconfiguration

Methods in org.nuxeo.ecm.platform.faceted.search.jsf.localconfiguration that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	FacetedSearchConfigurationAdapter.getDocumentRef()

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 and 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 and 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 and 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.
IOResources	IOResourceAdapter.extractResources(String repo, Collection<DocumentRef> sources) Extracts resources for given document locations.
abstract IOResources	AbstractIOResourceAdapter.extractResources(String repo, Collection<DocumentRef> sources)

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 and 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 and 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 and 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 and Description
DocumentModel	CreatePicture.run(DocumentRef doc)

Uses of DocumentRef in org.nuxeo.ecm.platform.preview.helper

Methods in org.nuxeo.ecm.platform.preview.helper that return DocumentRef

Modifier and Type	Method and Description
static DocumentRef	PreviewHelper.getDocumentRefFromPreviewURL(String url)

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 and 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 and Description
DocumentRef	SimpleCorePublishedDocument.getSourceDocumentRef()
DocumentRef	CoreFolderPublicationNode.getTargetDocumentRef()

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

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

Modifier and Type	Method and Description
DocumentRef	FSPublishedDocument.getSourceDocumentRef()

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.remoting.marshaling

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

Constructor and Description
ExtendedDocumentLocation(String serverName, DocumentRef docRef)
ExtendedDocumentLocation(String originalServer, String serverName, DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.remoting.marshaling.basic

Methods in org.nuxeo.ecm.platform.publisher.remoting.marshaling.basic that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	BasicPublishedDocument.getSourceDocumentRef()

Constructors in org.nuxeo.ecm.platform.publisher.remoting.marshaling.basic with parameters of type DocumentRef

Constructor and Description
BasicPublishedDocument(DocumentRef docRef, String repositoryName, String serverName, String versionLabel, String path, String parentPath, boolean isPending)

Uses of DocumentRef in org.nuxeo.ecm.platform.publisher.remoting.server

Methods in org.nuxeo.ecm.platform.publisher.remoting.server that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	ExternalCorePublishedDocument.getSourceDocumentRef()

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

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

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

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

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

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

Constructor and Description
IORelationResources(Map<String,String> namespaces, Map<DocumentRef,Set<Resource>> documentResources, List<Statement> statements)

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

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

Constructor and Description
RenditionPublicationFactory.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 and Description
DocumentRef	RenditionCreator.getRenditionDocumentRef()
DocumentRef	RenditionServiceImpl.storeRendition(DocumentModel source, String renditionDefinitionName)
DocumentRef	RenditionService.storeRendition(DocumentModel sourceDocument, String renditionDefinitionName) Render a document based on the given rendition definition name and returns the stored Rendition DocumentRef.

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 and 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

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

Modifier and Type	Method and 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.

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 and Description
DocumentRef	DashBoardItemImpl.getDocRef()
DocumentRef	DashBoardItem.getDocRef() Returns the document reference on which the item is bound.

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

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

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

Uses of DocumentRef in org.nuxeo.ecm.platform.ui.web.api

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

Modifier and Type	Method and Description
String	NavigationContext.navigateTo(RepositoryLocation serverLocation, DocumentRef docRef) Initializes the context for the given refs and returns the default view for the doc.
String	NavigationContext.navigateToRef(DocumentRef docRef) Updates the context and returns the view for the given document ref.

Uses of DocumentRef in org.nuxeo.ecm.platform.ui.web.cache

Methods in org.nuxeo.ecm.platform.ui.web.cache with parameters of type DocumentRef

Modifier and Type	Method and Description
void	ThreadSafeCacheHolder.addToCache(DocumentRef docRef, String key, T value)
T	ThreadSafeCacheHolder.getFromCache(DocumentRef docRef, String key)
void	ThreadSafeCacheHolder.removeFromCache(DocumentRef docRef, String key)

Uses of DocumentRef in org.nuxeo.ecm.platform.ui.web.component.document

Methods in org.nuxeo.ecm.platform.ui.web.component.document that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	RestDocumentLink.getDocumentIdRef()

Methods in org.nuxeo.ecm.platform.ui.web.component.document with parameters of type DocumentRef

Modifier and Type	Method and Description
void	RestDocumentLink.setDocumentIdRef(DocumentRef documentIdRef)

Uses of DocumentRef in org.nuxeo.ecm.platform.ui.web.util

Methods in org.nuxeo.ecm.platform.ui.web.util that return types with arguments of type DocumentRef

Modifier and Type	Method and Description
static List<DocumentRef>	DocumentsListsUtils.getDocRefs(List<DocumentModel> documentsList) Returns list of DocumentRef corresponding to the list of documents.
static List<DocumentRef>	DocumentsListsUtils.getParentRefFromDocumentList(List<DocumentModel> documentList) Returns the list of parents documentRef.

Methods in org.nuxeo.ecm.platform.ui.web.util with parameters of type DocumentRef

Modifier and Type	Method and Description
static String	DocumentLocator.getDocumentUrl(RepositoryLocation serverLocation, DocumentRef docRef) Deprecated.
static String	DocumentLocator.getDocumentUrl(String serverLocationName, DocumentRef docRef) Deprecated. Returns something like getDocument.faces?docRef=ServerLocationName/DocRef.
static String	DocumentLocator.getFullDocumentUrl(RepositoryLocation serverLocation, DocumentRef docRef) Deprecated. Returns something like http://server:port/nuxeo/getDocument.xhtml?docRef=ServerLocationName/DocRef.
static String	DocumentLocator.getFullDocumentUrl(String serverLocation, DocumentRef docRef) Deprecated. Returns something like http://server:port/nuxeo/getDocument.xhtml?docRef=ServerLocationName/DocRef.

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

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

Modifier and Type	Method and Description
Long	SetQuotaInfoOperation.run(DocumentRef docRef)
JsonAdapter	GetQuotaInfoOperation.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 and Description
DocumentObject	JSONDocumentObject.newDocument(DocumentRef ref)

Uses of DocumentRef in org.nuxeo.ecm.social.workspace.listeners

Method parameters in org.nuxeo.ecm.social.workspace.listeners with type arguments of type DocumentRef

Modifier and Type	Method and Description
void	SocialWorkspaceMembersManagementListener.addDocumentContextToMap(Map<DocumentRef,List<Event>> socialDocuments, Event event)

Uses of DocumentRef in org.nuxeo.ecm.social.workspace.service

Methods in org.nuxeo.ecm.social.workspace.service with parameters of type DocumentRef

Modifier and Type	Method and Description
SocialWorkspace	SocialWorkspaceServiceImpl.getDetachedSocialWorkspace(CoreSession session, DocumentRef docRef)
SocialWorkspace	SocialWorkspaceService.getDetachedSocialWorkspace(CoreSession session, DocumentRef docRef) Returns the SocialWorkspace container of the given document ref if it is in a Social Workspace even if the user does not have right on it, null otherwise.

Uses of DocumentRef in org.nuxeo.ecm.user.center.dashboard

Fields in org.nuxeo.ecm.user.center.dashboard declared as DocumentRef

Modifier and Type	Field and Description
DocumentRef	AnonymousDashboardSpaceCreator.anonymousDashboardSpaceRef
DocumentRef	UserDashboardSpaceProvider.DefaultDashboardSpaceCopy.copiedSpaceRef
DocumentRef	DefaultDashboardSpaceCreator.defaultDashboardSpaceRef

Uses of DocumentRef in org.nuxeo.ecm.webapp.clipboard

Methods in org.nuxeo.ecm.webapp.clipboard that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	SummaryEntry.getDocumentRef()

Methods in org.nuxeo.ecm.webapp.clipboard with parameters of type DocumentRef

Modifier and Type	Method and Description
boolean	ClipboardActionsBean.exists(DocumentRef ref)
String	ClipboardActionsBean.removeWorkListItem(DocumentRef ref)
String	ClipboardActions.removeWorkListItem(DocumentRef ref) Called when the delete button is clicked on the clipboard.
void	SummaryEntry.setDocumentRef(DocumentRef documentRef)
void	SummaryEntry.setParent(DocumentRef parentRef)

Constructors in org.nuxeo.ecm.webapp.clipboard with parameters of type DocumentRef

Constructor and Description
SummaryEntry(DocumentRef reference)

Uses of DocumentRef in org.nuxeo.ecm.webapp.context

Methods in org.nuxeo.ecm.webapp.context with parameters of type DocumentRef

Modifier and Type	Method and Description
String	NavigationContextBean.navigateTo(RepositoryLocation serverLocation, DocumentRef docRef)
String	NavigationContextBean.navigateToRef(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.webapp.helpers

Methods in org.nuxeo.ecm.webapp.helpers with parameters of type DocumentRef

Modifier and Type	Method and Description
String	ParalleleNavigationHelper.getDocumentFullUrl(DocumentRef docRef)

Uses of DocumentRef in org.nuxeo.ecm.webapp.localconfiguration.search

Methods in org.nuxeo.ecm.webapp.localconfiguration.search that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	SearchLocalConfigurationAdapter.getDocumentRef()

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 and Description
boolean	SimpleBackend.canUnlock(DocumentRef ref)
boolean	Backend.canUnlock(DocumentRef ref)
boolean	AbstractVirtualBackend.canUnlock(DocumentRef ref)
String	SimpleBackend.getCheckoutUser(DocumentRef ref)
String	Backend.getCheckoutUser(DocumentRef ref)
String	AbstractVirtualBackend.getCheckoutUser(DocumentRef ref)
List<DocumentModel>	SimpleBackend.getChildren(DocumentRef ref)
List<DocumentModel>	Backend.getChildren(DocumentRef ref)
List<DocumentModel>	AbstractVirtualBackend.getChildren(DocumentRef ref)
boolean	SimpleBackend.hasPermission(DocumentRef docRef, String permission)
boolean	Backend.hasPermission(DocumentRef docRef, String permission)
boolean	AbstractVirtualBackend.hasPermission(DocumentRef docRef, String permission)
boolean	SimpleBackend.isLocked(DocumentRef ref)
boolean	Backend.isLocked(DocumentRef ref)
boolean	AbstractVirtualBackend.isLocked(DocumentRef ref)
String	SimpleBackend.lock(DocumentRef ref)
String	Backend.lock(DocumentRef ref)
String	AbstractVirtualBackend.lock(DocumentRef ref)
DocumentModel	SimpleBackend.moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
DocumentModel	Backend.moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
DocumentModel	AbstractVirtualBackend.moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
void	SimpleBackend.removeItem(DocumentRef ref)
void	Backend.removeItem(DocumentRef ref)
void	AbstractVirtualBackend.removeItem(DocumentRef ref)
boolean	SimpleBackend.unlock(DocumentRef ref)
boolean	Backend.unlock(DocumentRef ref)
boolean	AbstractVirtualBackend.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 and Description
static void	ACLUtils.removePermission(CoreSession session, DocumentRef docRef, String username, String permission)

Uses of DocumentRef in org.nuxeo.search.ui.localconfiguration

Methods in org.nuxeo.search.ui.localconfiguration that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	SearchConfigurationAdapter.getDocumentRef()

Uses of DocumentRef in org.nuxeo.snapshot

Methods in org.nuxeo.snapshot that return DocumentRef

Modifier and Type	Method and Description
DocumentRef	SnapshotableAdapter.getRef()
DocumentRef	Snapshot.getRef()

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

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

Modifier and Type	Method and 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 and Description
DocumentRef	TemplateBasedDocument.getSourceTemplateDocRef(String templateName) Retrieve the Template DocumentRef for a given template name

Uses of DocumentRef in org.nuxeo.theme.localconfiguration

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

Modifier and Type	Method and Description
DocumentRef	LocalThemeConfigAdapter.getDocumentRef()