Package com.appiancorp.suiteapi.security.auth

Enum Class PasswordStatus

java.lang.Object

java.lang.Enum<PasswordStatus>

com.appiancorp.suiteapi.security.auth.PasswordStatus

All Implemented Interfaces:

Serializable, Comparable<PasswordStatus>, Constable

public enum PasswordStatus
extends Enum<PasswordStatus>

This enumeration specifies the different states that a user's password can have in Appian.

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
EXPIRATION_WARNING
EXPIRED
NORMAL
TEMPORARY

Method Summary

Modifier and Type	Method	Description
boolean	isForceSetPassword()	Returns true is this status is one of the password states in which the user should be forced to change the password.
static PasswordStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PasswordStatus[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORMAL

public static final PasswordStatus NORMAL

TEMPORARY

public static final PasswordStatus TEMPORARY

EXPIRED

public static final PasswordStatus EXPIRED

EXPIRATION_WARNING

public static final PasswordStatus EXPIRATION_WARNING

Method Details

values

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

isForceSetPassword

public boolean isForceSetPassword()

Returns true is this status is one of the password states in which the user should be forced to change the password. These states are: TEMPORARY and EXPIRED.