org.nuxeo.ecm.core.api.facet

Interface VersioningDocument

All Known Implementing Classes:

VersioningDocumentAdapter

public interface VersioningDocument

Declares constants and methods used to control document versions mostly when a document is saved.

Author:

Dragos Mihalache

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_SNAPSHOT_ON_SAVE_KEY Deprecated. use VersioningService#VERSIONING_OPTION instead
static String	CURRENT_DOCUMENT_MAJOR_VERSION_KEY
static String	CURRENT_DOCUMENT_MINOR_VERSION_KEY Key used in options map to send current versions to versioning listener so it will know what version the document had before restoring.
static String	KEY_FOR_INC_OPTION Deprecated. use VersioningService#VERSIONING_OPTION instead
static String	RESTORED_VERSION_UUID_KEY Key used in options map to send the UUID of the version being restored to the listeners.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getMajorVersion() Deprecated. use VersioningService#getVersionLabel instead
Long	getMinorVersion() Deprecated. use VersioningService#getVersionLabel instead
String	getVersionLabel() Returns a string representation of the version number.

Field Detail

CREATE_SNAPSHOT_ON_SAVE_KEY

@Deprecated
static final String CREATE_SNAPSHOT_ON_SAVE_KEY

Deprecated. use VersioningService#VERSIONING_OPTION instead

See Also:

Constant Field Values

KEY_FOR_INC_OPTION

@Deprecated
static final String KEY_FOR_INC_OPTION

Deprecated. use VersioningService#VERSIONING_OPTION instead

See Also:

Constant Field Values

CURRENT_DOCUMENT_MINOR_VERSION_KEY

static final String CURRENT_DOCUMENT_MINOR_VERSION_KEY

Key used in options map to send current versions to versioning listener so it will know what version the document had before restoring.

See Also:

Constant Field Values

CURRENT_DOCUMENT_MAJOR_VERSION_KEY

static final String CURRENT_DOCUMENT_MAJOR_VERSION_KEY

See Also:

Constant Field Values

RESTORED_VERSION_UUID_KEY

static final String RESTORED_VERSION_UUID_KEY

Key used in options map to send the UUID of the version being restored to the listeners.

See Also:

Constant Field Values

Method Detail

getMinorVersion

@Deprecated
Long getMinorVersion()
                     throws DocumentException

Deprecated. use VersioningService#getVersionLabel instead

Throws:

DocumentException

getMajorVersion

@Deprecated
Long getMajorVersion()
                     throws DocumentException

Deprecated. use VersioningService#getVersionLabel instead

Throws:

DocumentException

getVersionLabel

String getVersionLabel()

Returns a string representation of the version number.

Returns:

a string, like "2.1"