Enum Class StatusFilter
java.lang.Object
java.lang.Enum<StatusFilter>
org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter
- All Implemented Interfaces:
Serializable
,Comparable<StatusFilter>
,Constable
The StatusFilter is used on the API to Filter the status of instances.
- ALL All instances irrespective of status.
- ACTIVE: Only active instances.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionint
Return the numerical value for the enum.Return the description for the enum.Return the descriptive name for the enum.static StatusFilter
Returns the enum constant of this class with the specified name.static StatusFilter[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ALL
All instances irrespective of status. -
ACTIVE
Only active instances.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrdinal
public int getOrdinal()Return the numerical value for the enum.- Returns:
- int enum value ordinal
-
getStatusFilterName
Return the descriptive name for the enum.- Returns:
- String name
-
getStatusFilterDescription
Return the description for the enum.- Returns:
- String description
-