org.nuxeo.ecm.core.search.api.client.search.results.document.impl
Class ResultDocumentModel

java.lang.Object
  org.nuxeo.ecm.core.api.impl.DocumentModelImpl
      org.nuxeo.ecm.core.search.api.client.search.results.document.impl.ResultDocumentModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, DocumentModel

public class ResultDocumentModel
extends DocumentModelImpl

A DocumentModel that caches info that DocumentModelImpl would fetch from the core.

Typical use-case: search engine results can have said info that is needed to build a viable DocumentModel for results display.

Author:

Georges Racinet

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.api.DocumentModel

DocumentModel.DocumentModelRefresh

Field Summary

Fields inherited from class org.nuxeo.ecm.core.api.impl.DocumentModelImpl

F_DETACHED, F_DIRTY, F_IMMUTABLE, F_LOCKED, F_PROXY, F_STORED, F_VERSION, reentrantCoreSession, STRICT_LAZY_LOADING_POLICY_KEY

Fields inherited from interface org.nuxeo.ecm.core.api.DocumentModel

REFRESH_ACP, REFRESH_ACP_IF_LOADED, REFRESH_ACP_LAZY, REFRESH_ALL, REFRESH_CONTENT, REFRESH_CONTENT_IF_LOADED, REFRESH_CONTENT_LAZY, REFRESH_DEFAULT, REFRESH_IF_LOADED, REFRESH_LAZY, REFRESH_PREFETCH, REFRESH_STATE

Constructor Summary

ResultDocumentModel(java.lang.String type, java.lang.String id, Path path, DocumentRef docRef, DocumentRef parentRef, java.lang.String[] schemas, java.util.Set<java.lang.String> facets, java.lang.String lifeCycleState, java.lang.String versionLabel, java.lang.String repoName)
Deprecated.

ResultDocumentModel(java.lang.String type, java.lang.String id, Path path, DocumentRef docRef, DocumentRef parentRef, java.lang.String[] schemas, java.util.Set<java.lang.String> facets, java.lang.String lifeCycleState, java.lang.String versionLabel, java.lang.String repoName, long flags)

Method Summary

java.lang.String	getCurrentLifeCycleState() Returns the life cycle of the document.
java.lang.String	getVersionLabel() Returns the version label.

Methods inherited from class org.nuxeo.ecm.core.api.impl.DocumentModelImpl

addDataModel, checkIn, checkOut, clearFlags, clearFlags, clone, cloneDataModel, cloneDataModel, cloneField, copyContent, copyContentInto, copyContextData, detach, equals, followTransition, getACP, getAdapter, getAdapter, getAllowedStateTransitions, getCacheKey, getCheckinComment, getClient, getContextData, getContextData, getContextData, getCoreSession, getDataModel, getDataModels, getDataModelsCollection, getDeclaredFacets, getDeclaredSchemas, getDocumentType, getFlags, getId, getLifeCyclePolicy, getLock, getName, getParentRef, getPart, getParts, getPath, getPathAsString, getPrefetch, getProperties, getProperty, getProperty, getPropertyValue, getRef, getRepositoryName, getSessionId, getSourceId, getSystemProp, getTitle, getType, getVersionSeriesId, hasFacet, hasFlags, hashCode, hasSchema, isCheckedOut, isDownloadable, isFolder, isImmutable, isLatestMajorVersion, isLatestVersion, isLifeCycleLoaded, isLocked, isMajorVersion, isProxy, isSchemaLoaded, isVersion, isVersionable, isVersionSeriesCheckedOut, prefetchCurrentLifecycleState, prefetchLifeCyclePolicy, prefetchProperty, putContextData, putContextData, refresh, refresh, reset, setACP, setFlags, setIsImmutable, setIsProxy, setIsVersion, setLock, setPathInfo, setProperties, setProperty, setPropertyValue, toString, unlock

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResultDocumentModel

@Deprecated
public ResultDocumentModel(java.lang.String type,
                                      java.lang.String id,
                                      Path path,
                                      DocumentRef docRef,
                                      DocumentRef parentRef,
                                      java.lang.String[] schemas,
                                      java.util.Set<java.lang.String> facets,
                                      java.lang.String lifeCycleState,
                                      java.lang.String versionLabel,
                                      java.lang.String repoName)

Deprecated.

ResultDocumentModel

public ResultDocumentModel(java.lang.String type,
                           java.lang.String id,
                           Path path,
                           DocumentRef docRef,
                           DocumentRef parentRef,
                           java.lang.String[] schemas,
                           java.util.Set<java.lang.String> facets,
                           java.lang.String lifeCycleState,
                           java.lang.String versionLabel,
                           java.lang.String repoName,
                           long flags)

Method Detail

getCurrentLifeCycleState

public java.lang.String getCurrentLifeCycleState()

Description copied from interface: DocumentModel

Returns the life cycle of the document.

Specified by:

getCurrentLifeCycleState in interface DocumentModel

Overrides:

getCurrentLifeCycleState in class DocumentModelImpl

Returns:

the life cycle as a string

See Also:

org.nuxeo.ecm.core.lifecycle

getVersionLabel

public java.lang.String getVersionLabel()

Description copied from interface: DocumentModel

Returns the version label.

The label returned is computed by the VersioningService.

Specified by:

getVersionLabel in interface DocumentModel

Overrides:

getVersionLabel in class DocumentModelImpl

Returns:

the version label, or null