org.odpi.openmetadata.accessservices.subjectarea.properties.enums

Enum StatusFilter

java.lang.Object

java.lang.Enum<StatusFilter>

org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter

All Implemented Interfaces:

Serializable, Comparable<StatusFilter>

public enum StatusFilter
extends Enum<StatusFilter>
implements Serializable

The StatusFilter is used on the API to Filter the status of instances.

• ALL All instances irrespective of status.
• ACTIVE: Only active instances.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Only active instances.
ALL All instances irrespective of status.

Method Summary

Modifier and Type	Method and Description
int	getOrdinal() Return the numerical value for the enum.
String	getStatusFilterDescription() Return the description for the enum.
String	getStatusFilterName() Return the descriptive name for the enum.
static StatusFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatusFilter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALL

public static final StatusFilter ALL

All instances irrespective of status.

ACTIVE

public static final StatusFilter ACTIVE

Only active instances.

Method Detail

values

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

Returns:

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

valueOf

public static StatusFilter 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

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getStatusFilterName

public String getStatusFilterName()

Return the descriptive name for the enum.

Returns:

String name

getStatusFilterDescription

public String getStatusFilterDescription()

Return the description for the enum.

Returns:

String description