org.nuxeo.ecm.platform.versioning.api

Interface VersioningManager

All Known Implementing Classes:

VersioningManagerImpl

public interface VersioningManager

Interface for the Versioning Manager (a service).

Method Summary

Methods

Modifier and Type	Method and Description
String	getMajorVersionPropertyName(String documentType) Deprecated. since 5.4, use DocumentModel#MAJOR_VERSION directly
String	getMinorVersionPropertyName(String documentType) Deprecated. since 5.4, use DocumentModel#MINOR_VERSION directly
VersionIncEditOptions	getVersionIncEditOptions(DocumentModel doc) Get document increment options as defined by versioning rules.
String	getVersionLabel(DocumentModel doc) Gets the label for the current version of a document, for the UI.
DocumentModel	incrementMajor(DocumentModel doc) Deprecated. since 5.4
DocumentModel	incrementMinor(DocumentModel doc) Deprecated. since 5.4

Method Detail

getVersionIncEditOptions

VersionIncEditOptions getVersionIncEditOptions(DocumentModel doc)
                                               throws ClientException

Get document increment options as defined by versioning rules.

Parameters:

doc - the document

Returns:

a list of version increment options available for the given document

Throws:

ClientException

getVersionLabel

String getVersionLabel(DocumentModel doc)
                       throws ClientException

Gets the label for the current version of a document, for the UI.

Parameters:

doc - the document

Returns:

the version label

Throws:

ClientException

getMajorVersionPropertyName

@Deprecated
String getMajorVersionPropertyName(String documentType)

Deprecated. since 5.4, use DocumentModel#MAJOR_VERSION directly

Returns the property name to use when setting the major version for this document type.

getMinorVersionPropertyName

@Deprecated
String getMinorVersionPropertyName(String documentType)

Deprecated. since 5.4, use DocumentModel#MINOR_VERSION directly

Returns the property name to use when setting the minor version for this document type.

incrementMinor

@Deprecated
DocumentModel incrementMinor(DocumentModel doc)
                             throws ClientException

Deprecated. since 5.4

Increments the minor version of a document.

Parameters:

doc - the document

Throws:

ClientException

incrementMajor

@Deprecated
DocumentModel incrementMajor(DocumentModel doc)
                             throws ClientException

Deprecated. since 5.4

Increments the major version of a document and sets the minor to 0.

Parameters:

doc - the document

Throws:

ClientException