Package mc.core.model.base

Enum Class LifeCycleFlag

java.lang.Object

java.lang.Enum<LifeCycleFlag>

mc.core.model.base.LifeCycleFlag

All Implemented Interfaces:

Serializable, Comparable<LifeCycleFlag>, Constable

public enum LifeCycleFlag
extends Enum<LifeCycleFlag>

Enumeration that is used to differentiate between primary states of an object. Objects get the flag RELEASED on creation. When an object is deleted asynchronously it gets the flag DELETED until the background job permanently removes it from the database. entities are often filtered in queries by the LifeCycleFlag.DELETED to hide them in GUI or skip them in exports.

IMPORTANT: enumeration is mapped by ordinal so do not change declaration order of enumeration constants!

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARCHIVED	Marks an object as archived.
DELETED	Marks an object as deleted.
EDIT	Reserved, not used
IMPORTED	Reserved, not used
RECYCLED	Marks an object as "moved" to recycle bin, which is only a marker to hide it for the usual user.
RELEASED	Default flag for all inserted entities

Method Summary

Modifier and Type	Method	Description
static List<LifeCycleFlag>	hidden()
boolean	isHidden()
boolean	isVisible()
static LifeCycleFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LifeCycleFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static List<LifeCycleFlag>	visible()

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EDIT

public static final LifeCycleFlag EDIT

Reserved, not used

RELEASED

public static final LifeCycleFlag RELEASED

Default flag for all inserted entities

IMPORTED

public static final LifeCycleFlag IMPORTED

Reserved, not used

DELETED

public static final LifeCycleFlag DELETED

Marks an object as deleted. References to such objects might still be returned by outdated/delayed indices but the flag allows to filter them.

ARCHIVED

public static final LifeCycleFlag ARCHIVED

Marks an object as archived. Data or partial data may have been deleted or exported from system to a backend storage. The exact definition of this flag depends on objectclass and business logic. hidden for the usual user since 7.6 (see MC-4587)

RECYCLED

public static final LifeCycleFlag RECYCLED

Marks an object as "moved" to recycle bin, which is only a marker to hide it for the usual user. Object is still in place, referenced and keeps all data. If moved back from recycle bin it get's the Flag RELEASED.

Method Details

values

public static LifeCycleFlag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LifeCycleFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isVisible

public boolean isVisible()

isHidden

public boolean isHidden()

visible

public static List<LifeCycleFlag> visible()

hidden

public static List<LifeCycleFlag> hidden()