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

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	DOCUMENT_WAS_SNAPSHOTTED Deprecated.
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

Long	getMajorVersion() Deprecated. use VersioningService#getVersionLabel instead
Long	getMinorVersion() Deprecated. use VersioningService#getVersionLabel instead
String	getVersionAsString(int majorDigits, int minorDigits, char sep) Deprecated. unused
String	getVersionLabel() Returns a string representation of the version number.
void	incrementMajor() Deprecated. let VersioningService do its work
void	incrementMinor() Deprecated. let VersioningService do its work
void	incrementVersions() Deprecated. unused
void	refetchDoc() Deprecated. unused
void	setMajorVersion(Long value) Deprecated. let VersioningService do its work
void	setMinorVersion(Long value) Deprecated. let VersioningService do its work

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

DOCUMENT_WAS_SNAPSHOTTED

@Deprecated
static final String DOCUMENT_WAS_SNAPSHOTTED

Deprecated.

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"

setMinorVersion

@Deprecated
void setMinorVersion(Long value)

Deprecated. let VersioningService do its work

setMajorVersion

@Deprecated
void setMajorVersion(Long value)

Deprecated. let VersioningService do its work

incrementMajor

@Deprecated
void incrementMajor()
                    throws DocumentException

Deprecated. let VersioningService do its work

Throws:

DocumentException

incrementMinor

@Deprecated
void incrementMinor()
                    throws DocumentException

Deprecated. let VersioningService do its work

Throws:

DocumentException

refetchDoc

@Deprecated
void refetchDoc()
                throws DocumentException

Deprecated. unused

Throws:

DocumentException

incrementVersions

@Deprecated
void incrementVersions()

Deprecated. unused

getVersionAsString

@Deprecated
String getVersionAsString(int majorDigits,
                                     int minorDigits,
                                     char sep)
                          throws DocumentException

Deprecated. unused

Throws:

DocumentException