Package org.odpi.openmetadata.frameworks.connectors.properties.users

Enum Class UserAccountStatus

java.lang.Object

java.lang.Enum<UserAccountStatus>

org.odpi.openmetadata.frameworks.connectors.properties.users.UserAccountStatus

All Implemented Interfaces:

Serializable, Comparable<UserAccountStatus>, Constable

public enum UserAccountStatus
extends Enum<UserAccountStatus>

The UserAccountStatus enum defines the status of a user account

• Disabled: The user account is not in use.
• Locked: The user account is in use but is temporarily locked.
• CredentialsExpired: The user account is in use and unlocked, but the credentials have expired.
• Available: The user account is enabled and unlocked, with active credentials.

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
AVAILABLE	The user account is enabled and unlocked, with active credentials.
CREDENTIALS_EXPIRED	The user account is in use and unlocked, but the credentials have expired.
DISABLED	The user account is not in use.
LOCKED	The user account is in use but is temporarily locked.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description for the enum.
String	getName()	Return the descriptive name for the enum.
int	getOrdinal()	Return the numerical value for the enum.
String	toString()	toString() JSON-style
static UserAccountStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserAccountStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final UserAccountStatus DISABLED

The user account is not in use.

LOCKED

public static final UserAccountStatus LOCKED

The user account is in use but is temporarily locked.

CREDENTIALS_EXPIRED

public static final UserAccountStatus CREDENTIALS_EXPIRED

The user account is in use and unlocked, but the credentials have expired.

AVAILABLE

public static final UserAccountStatus AVAILABLE

The user account is enabled and unlocked, with active credentials.

Method Details

values

public static UserAccountStatus[] 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 UserAccountStatus 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

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getName

public String getName()

Return the descriptive name for the enum.

Returns:

String name

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<UserAccountStatus>

Returns:

string description