Package org.nuxeo.ecm.platform.versioning.api

Class VersionIncEditOptions

java.lang.Object

org.nuxeo.ecm.platform.versioning.api.VersionIncEditOptions

All Implemented Interfaces:

Serializable

public class VersionIncEditOptions
extends Object
implements Serializable

This class composes a result of versioning interrogation about what increment options are available.

See Also:

• VersioningActions
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
VersionIncEditOptions()

Method Summary

Modifier and Type	Method	Description
void	addOption(VersioningActions option)
VersioningActions	getDefaultVersioningAction()	Returns action to be presented by default to user.
List<VersioningActions>	getOptions()
Map<String,String>	getOptionsForDisplay()	Returns the versioning selection options for display.
boolean	hasOptions()	Returns true if some incrementation options are defined.
void	setDefaultVersioningAction(VersioningActions defaultVersioningAction)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VersionIncEditOptions

public VersionIncEditOptions()

Method Details

getDefaultVersioningAction

public VersioningActions getDefaultVersioningAction()

Returns action to be presented by default to user.

Since 5.7.3, returns VersioningActions.ACTION_NO_INCREMENT by default instead of null, when not set.

setDefaultVersioningAction

public void setDefaultVersioningAction(VersioningActions defaultVersioningAction)

addOption

public void addOption(VersioningActions option)

getOptions

public List<VersioningActions> getOptions()

hasOptions

public boolean hasOptions()

Returns true if some incrementation options are defined.

Since:

5.7.3

getOptionsForDisplay

public Map<String,String> getOptionsForDisplay()

Returns the versioning selection options for display.

Since:

5.7.3

toString

public String toString()

Overrides:

toString in class Object