com.appiancorp.suiteapi.security.auth

Enum PasswordStatus

java.lang.Object

java.lang.Enum<PasswordStatus>

com.appiancorp.suiteapi.security.auth.PasswordStatus

All Implemented Interfaces:

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

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPIRATION_WARNING
EXPIRED
NORMAL
TEMPORARY

Method Summary

Modifier and Type	Method and 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(java.lang.String name) Returns the enum constant of this type with the specified name.
static PasswordStatus[]	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

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 Detail

values

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

Returns:

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

valueOf

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

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.