Package org.nuxeo.ecm.core.api.versioning

Interface VersioningService

All Known Subinterfaces:

ExtendableVersioningService, VersioningService

All Known Implementing Classes:

CompatVersioningService, StandardVersioningService, VersioningComponent

public interface VersioningService

The versioning service holds the versioning policy used to define what happens to a document's version when it is created, saved, checked in, checked out or restored, and what version increment options (none, minor, major) are made available to the user.

Since:

5.4

Field Summary

Fields

Modifier and Type	Field	Description
static String	CHECKIN_COMMENT	Context data to provide a checkin comment for operations that potentially check in (save, publish, checkin).
static String	DISABLE_AUTO_CHECKOUT	Context data to disable auto-checkout of checked-in documents at pre-save time.
static String	DISABLE_AUTOMATIC_VERSIONING	Context data to disable the automatic versioning engine.
static String	MAJOR_VERSION_PROP	Document property in which the major version is stored.
static String	MINOR_VERSION_PROP	Document property in which the minor version is stored.
static String	SKIP_VERSIONING	Context data that can be used to skip versioning on document creation, in case the supplied version is enough.
static String	VERSIONING_OPTION	Context data to provide a user-level choice to the versioning policy.

Method Summary

Modifier and Type	Method	Description
void	doAutomaticVersioning(DocumentModel previousDocument, DocumentModel currentDocument, boolean before)	Does automatic versioning if a policy exists for the current input context.
Document	doCheckIn(Document doc, VersioningOption option, String checkinComment)	Applies version increment option and does a checkin.
void	doCheckOut(Document doc)	Apply modifications after doing a checkout.
void	doPostCreate(Document doc, Map<String,Serializable> options)	Applies versioning after document creation.
Document	doPostSave(CoreSession session, Document doc, VersioningOption option, String checkinComment, Map<String,Serializable> options)	Applies versioning options after document save.
VersioningOption	doPreSave(CoreSession session, Document doc, boolean isDirty, VersioningOption option, String checkinComment, Map<String,Serializable> options)	Applies versioning options before document save.
List<VersioningOption>	getSaveOptions(DocumentModel doc)	Checks what options are available on a document at save time.
String	getVersionLabel(DocumentModel doc)	Gets the version label to display for a given document.
boolean	isPostSaveDoingCheckIn(Document doc, VersioningOption option, Map<String,Serializable> options)	Checks if doPostSave(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.model.Document, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkin when called with the same arguments.
boolean	isPreSaveDoingCheckOut(Document doc, boolean isDirty, VersioningOption option, Map<String,Serializable> options)	Checks if doPreSave(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.model.Document, boolean, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkout when called with the same arguments.

Field Detail

MAJOR_VERSION_PROP

static final String MAJOR_VERSION_PROP

Document property in which the major version is stored.

See Also:

Constant Field Values

MINOR_VERSION_PROP

static final String MINOR_VERSION_PROP

Document property in which the minor version is stored.

See Also:

Constant Field Values

SKIP_VERSIONING

static final String SKIP_VERSIONING

Context data that can be used to skip versioning on document creation, in case the supplied version is enough.

See Also:

Constant Field Values

VERSIONING_OPTION

static final String VERSIONING_OPTION

Context data to provide a user-level choice to the versioning policy. Value is a VersioningOption.

See Also:

Constant Field Values

DISABLE_AUTO_CHECKOUT

static final String DISABLE_AUTO_CHECKOUT

Context data to disable auto-checkout of checked-in documents at pre-save time. This option should only be used when updating a facet that's considered pure metadata and holds information about the document but external to it. Value is a Boolean.

Since:

5.7, 5.6.0-HF09

See Also:

Constant Field Values

CHECKIN_COMMENT

static final String CHECKIN_COMMENT

Context data to provide a checkin comment for operations that potentially check in (save, publish, checkin).

See Also:

Constant Field Values

DISABLE_AUTOMATIC_VERSIONING

static final String DISABLE_AUTOMATIC_VERSIONING

Context data to disable the automatic versioning engine.

Since:

2021.12

See Also:

Constant Field Values

Method Detail

getVersionLabel

String getVersionLabel(DocumentModel doc)

Gets the version label to display for a given document.

Parameters:

doc - the document

Returns:

the version label, like "2.1"

getSaveOptions

List<VersioningOption> getSaveOptions(DocumentModel doc)

Checks what options are available on a document at save time.

Parameters:

doc - the document

Returns:

the options, the first being the default

doPostCreate

void doPostCreate(Document doc,
                  Map<String,Serializable> options)

Applies versioning after document creation.

Parameters:

doc - the document

options - map event info

isPreSaveDoingCheckOut

boolean isPreSaveDoingCheckOut(Document doc,
                               boolean isDirty,
                               VersioningOption option,
                               Map<String,Serializable> options)

Checks if doPreSave(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.model.Document, boolean, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkout when called with the same arguments.

Needed to be able to send "about to checkin" events.

Parameters:

doc - the document

isDirty - true if there is actual data to save

option - an option chosen by the user or framework

options - map event info and options

Returns:

true if doPreSave(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.model.Document, boolean, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkout

doPreSave

VersioningOption doPreSave(CoreSession session,
                           Document doc,
                           boolean isDirty,
                           VersioningOption option,
                           String checkinComment,
                           Map<String,Serializable> options)

Applies versioning options before document save.

Parameters:

session - the core session

doc - the document

isDirty - true if there is actual data to save

option - an option chosen by the user or framework

checkinComment - a checkin comment

options - map event info

Returns:

the validated option (to use in doPostSave)

Since:

9.3

isPostSaveDoingCheckIn

boolean isPostSaveDoingCheckIn(Document doc,
                               VersioningOption option,
                               Map<String,Serializable> options)

Checks if doPostSave(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.model.Document, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkin when called with the same arguments.

Parameters:

doc - the document

option - an option chosen by the user or framework

options - map event info

Returns:

true if doPostSave(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.model.Document, org.nuxeo.ecm.core.api.VersioningOption, java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>) will do a checkin

doPostSave

Document doPostSave(CoreSession session,
                    Document doc,
                    VersioningOption option,
                    String checkinComment,
                    Map<String,Serializable> options)

Applies versioning options after document save. If a new version is checked in during the operation, the document for this version is returned to the caller.

Parameters:

session - the core session

doc - the document

option - an option chosen by the user or framework

checkinComment - a checkin comment

options - map event info

Returns:

checkedInDocument or null

Since:

9.3

doCheckIn

Document doCheckIn(Document doc,
                   VersioningOption option,
                   String checkinComment)

Applies version increment option and does a checkin.

Parameters:

doc - the document

option - an option chosen by the user or framework

checkinComment - a checkin comment

Returns:

the version

doCheckOut

void doCheckOut(Document doc)

Apply modifications after doing a checkout.

Parameters:

doc - the document

doAutomaticVersioning

void doAutomaticVersioning(DocumentModel previousDocument,
                           DocumentModel currentDocument,
                           boolean before)

Does automatic versioning if a policy exists for the current input context. Currently automatic versioning is either before or after document update, never both.

Parameters:

before - the flag to trigger a before or after automatic versioning (used to retrieve the right policy)

Since:

9.1