org.nuxeo.ecm.core.search.api.client.indexing.resources.document
Interface DocumentIndexableResource

All Superinterfaces:

IndexableResource, NXCoreIndexableResource, java.io.Serializable

All Known Subinterfaces:

DocumentBuiltinsIndexableResource

All Known Implementing Classes:

DocumentBuiltinsIndexableResourceImpl, DocumentIndexableResourceImpl

public interface DocumentIndexableResource
extends NXCoreIndexableResource

Document Indexable resource.

Access indexable data bound to a document model. This class aggregates only the mandatory information needed to access back a document from Nuxeo core.

Author:

Julien Anguenot

Method Summary

java.lang.String	getDocCurrentLifeCycleState() Returns the current life cycle state.
java.util.List<java.lang.String>	getDocFacets() Returns the facets declared by the document model.
ACP	getDocMergedACP() Returns the merged ACP for the bound document.
java.lang.String	getDocName() Returns the bound doc name.
DocumentRef	getDocParentRef() Returns the parent document reference.
Path	getDocPath() Returns the document path.
DocumentRef	getDocRef() Returns a the document reference.
java.lang.String	getDocType() Returns the document type.
java.lang.String	getDocURL() Returns the document URL.
java.lang.String	getDocUUID() Returns the document UUID.
java.lang.String	getDocVersionLabel() Returns the version label for the bound document.
java.lang.Long	getFlags() Returns the flags declared on the document model.
java.lang.String	getQid() Returns qualified id.
java.lang.Boolean	isDocProxy() Is the document a proxy ?
java.lang.Boolean	isDocVersion() Says if this is a checked in version or not.

Methods inherited from interface org.nuxeo.ecm.core.search.api.client.indexing.resources.document.NXCoreIndexableResource

closeCoreSession, getCoreSession, getDocRepositoryName

Methods inherited from interface org.nuxeo.ecm.core.search.api.client.indexing.resources.IndexableResource

computeAcp, computeId, getConfiguration, getName, getValueFor

Method Detail

getDocUUID

java.lang.String getDocUUID()

Returns the document UUID.

Returns:

the document UUID

getDocRef

DocumentRef getDocRef()

Returns a the document reference.

Returns:

a Nuxeo Core DocumenRef instance.

getDocParentRef

DocumentRef getDocParentRef()

Returns the parent document reference.

Useful for the backend while returning result items so that DocumentModel can be generated out.

Returns:

a Nuxeo Core DocumentRef instance.

getDocType

java.lang.String getDocType()

Returns the document type.

Returns:

the document type

getDocPath

Path getDocPath()

Returns the document path.

Returns:

the document path

getDocURL

java.lang.String getDocURL()

Returns the document URL.

Returns:

the document URL

getDocCurrentLifeCycleState

java.lang.String getDocCurrentLifeCycleState()

Returns the current life cycle state.

Returns:

the current life cycle state name.

getDocMergedACP

ACP getDocMergedACP()
                    throws IndexingException

Returns the merged ACP for the bound document.

Returns:

a Nuxeo Core API ACP instance.

Throws:

IndexingException

getDocVersionLabel

java.lang.String getDocVersionLabel()

Returns the version label for the bound document.

Returns:

the version label for the bound document.

getQid

java.lang.String getQid()

Returns qualified id. TODO

Returns:

the qualified identifier.

isDocVersion

java.lang.Boolean isDocVersion()

Says if this is a checked in version or not.

Returns:

true if the bound document is a version.

getDocName

java.lang.String getDocName()

Returns the bound doc name.

Returns:

the bound doc name.

isDocProxy

java.lang.Boolean isDocProxy()

Is the document a proxy ?

Returns:

getDocFacets

java.util.List<java.lang.String> getDocFacets()

Returns the facets declared by the document model.

Returns:

the facets declared by the document model.

getFlags

java.lang.Long getFlags()

Returns the flags declared on the document model.

Returns:

a long value (depending on the DocumentModelImpl for now.