com.sap.sl.sdk.authoring.businesslayer

Enum ItemState

java.lang.Object

java.lang.Enum<ItemState>

com.sap.sl.sdk.authoring.businesslayer.ItemState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ItemState>

public enum ItemState
extends java.lang.Enum<ItemState>

A representation of the literals of the 'Item State' enumeration and methods to use them.

This is the state of a business layer item in the Query Panel. See the Information Design Tool User Guide for more information.

See Also:

BusinessLayerPackageImpl.getItemState()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE The 'ACTIVE' literal object.
DEPRECATED The 'DEPRECATED' literal object.
HIDDEN The 'HIDDEN' literal object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_VALUE The 'ACTIVE' literal value.
static int	DEPRECATED_VALUE The 'DEPRECATED' literal value.
static int	HIDDEN_VALUE The 'HIDDEN' literal value.
static java.util.List<ItemState>	VALUES A public read-only list of all the 'Item State' enumerators.

Method Summary

Modifier and Type	Method and Description
static ItemState	get(int value) Returns the 'Item State' literal with the specified integer value.
static ItemState	get(java.lang.String literal) Returns the 'Item State' literal with the specified literal value.
static ItemState	getByName(java.lang.String name) Returns the 'Item State' literal with the specified name.
java.lang.String	getLiteral() Returns the string representation of the enumerator.
java.lang.String	getName() Returns the literal name of the enumerator.
int	getValue() Returns the literal integer value of the enumerator.
java.lang.String	toString() Returns the literal value of the enumerator, which is its string representation.
static ItemState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ItemState[]	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

ACTIVE

public static final ItemState ACTIVE

The 'ACTIVE' literal object.

Object is visible in the Query Panel. This is the default state.

See Also:

ACTIVE_VALUE

HIDDEN

public static final ItemState HIDDEN

The 'HIDDEN' literal object.

Object is valid but not available in the Query Panel (used by other objects as a hidden object).

See Also:

HIDDEN_VALUE

DEPRECATED

public static final ItemState DEPRECATED

The 'DEPRECATED' literal object.

Object is hidden and not valid.

See Also:

DEPRECATED_VALUE

Field Detail

ACTIVE_VALUE

public static final int ACTIVE_VALUE

The 'ACTIVE' literal value.

See Also:

ACTIVE, Constant Field Values

HIDDEN_VALUE

public static final int HIDDEN_VALUE

The 'HIDDEN' literal value.

See Also:

HIDDEN, Constant Field Values

DEPRECATED_VALUE

public static final int DEPRECATED_VALUE

The 'DEPRECATED' literal value.

See Also:

DEPRECATED, Constant Field Values

VALUES

public static final java.util.List<ItemState> VALUES

A public read-only list of all the 'Item State' enumerators.

Method Detail

values

public static ItemState[] 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 (ItemState c : ItemState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ItemState valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

get

public static ItemState get(java.lang.String literal)

Returns the 'Item State' literal with the specified literal value.

Parameters:

literal - The enumerator literal as a string

Returns:

An ItemState object

getByName

public static ItemState getByName(java.lang.String name)

Returns the 'Item State' literal with the specified name.

Parameters:

name - The literal name of the enumerator

Returns:

An ItemState object

get

public static ItemState get(int value)

Returns the 'Item State' literal with the specified integer value.

Parameters:

value - The literal integer value of the enumerator

Returns:

An ItemState object

getValue

public int getValue()

Returns the literal integer value of the enumerator.

Returns:

An integer that represents the literal value

getName

public java.lang.String getName()

Returns the literal name of the enumerator.

Returns:

A String that represents the literal name

getLiteral

public java.lang.String getLiteral()

Returns the string representation of the enumerator.

Returns:

A String that represents the enumerator

toString

public java.lang.String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class java.lang.Enum<ItemState>

Returns:

A String that represents the literal