org.nuxeo.ecm.platform.versioning.api

Enum VersioningActions

java.lang.Object

java.lang.Enum<VersioningActions>

org.nuxeo.ecm.platform.versioning.api.VersioningActions

All Implemented Interfaces:

Serializable, Comparable<VersioningActions>

public enum VersioningActions
extends Enum<VersioningActions>
implements Serializable

Defines actions to be taken in a document versioning increment process.

Used by UI.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION_INCREMENT_MAJOR
ACTION_INCREMENT_MINOR
ACTION_NO_INCREMENT

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_FOR_INC_OPTION
static String	SKIP_VERSIONING Deprecated. use VersioningService.SKIP_VERSIONING instead

Method Summary

Methods

Modifier and Type	Method and Description
static VersioningActions	getByActionName(String actionName)
static VersioningActions	getByVersioningOption(VersioningOption vo) Returns the corresponding core versioning option for this UI versioning action.
VersioningOption	getVersioningOption()
String	toString()
static VersioningActions	valueOf(String name) Returns the enum constant of this type with the specified name.
static VersioningActions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTION_NO_INCREMENT

public static final VersioningActions ACTION_NO_INCREMENT

ACTION_INCREMENT_MINOR

public static final VersioningActions ACTION_INCREMENT_MINOR

ACTION_INCREMENT_MAJOR

public static final VersioningActions ACTION_INCREMENT_MAJOR

Field Detail

KEY_FOR_INC_OPTION

public static final String KEY_FOR_INC_OPTION

See Also:

Constant Field Values

SKIP_VERSIONING

@Deprecated
public static final String SKIP_VERSIONING

Deprecated. use VersioningService.SKIP_VERSIONING instead

See Also:

Constant Field Values

Method Detail

values

public static VersioningActions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VersioningActions c : VersioningActions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VersioningActions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<VersioningActions>

getVersioningOption

public VersioningOption getVersioningOption()

getByActionName

public static VersioningActions getByActionName(String actionName)

getByVersioningOption

public static VersioningActions getByVersioningOption(VersioningOption vo)

Returns the corresponding core versioning option for this UI versioning action.

Since:

5.7.3