Package velox.api.layer1.agreement

Enum Class AgreementStatus

java.lang.Object

java.lang.Enum<AgreementStatus>

velox.api.layer1.agreement.AgreementStatus

All Implemented Interfaces:

Serializable, Comparable<AgreementStatus>, Constable

public enum AgreementStatus
extends Enum<AgreementStatus>

Represents the result status of an agreement acceptance request. Each status carries an isAccepted flag indicating whether the agreement is considered accepted for the purpose of further processing.

See Also:

• AgreementAcceptanceCallback

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
ALREADY_ACCEPTED	The agreement was already accepted previously and has not expired.
EXPIRED_AND_DECLINED	The previously accepted agreement has expired and the user declined to re-accept it.
JUST_ACCEPTED	The user has just accepted the agreement in the current dialog session.
JUST_DECLINED	The user has just declined the agreement in the current dialog session.
NETWORK_ERROR	A network error occurred while trying to process the agreement acceptance.
SERVER_ERROR	An unexpected error occurred on server (e.g.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	isAccepted	Indicates whether this status represents a successful agreement acceptance.

Method Summary

Modifier and Type	Method	Description
static AgreementStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AgreementStatus[]	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

JUST_ACCEPTED

public static final AgreementStatus JUST_ACCEPTED

The user has just accepted the agreement in the current dialog session.

ALREADY_ACCEPTED

public static final AgreementStatus ALREADY_ACCEPTED

The agreement was already accepted previously and has not expired.

JUST_DECLINED

public static final AgreementStatus JUST_DECLINED

The user has just declined the agreement in the current dialog session.

EXPIRED_AND_DECLINED

public static final AgreementStatus EXPIRED_AND_DECLINED

The previously accepted agreement has expired and the user declined to re-accept it.

NETWORK_ERROR

public static final AgreementStatus NETWORK_ERROR

A network error occurred while trying to process the agreement acceptance.

SERVER_ERROR

public static final AgreementStatus SERVER_ERROR

An unexpected error occurred on server (e.g. validation error, database error, etc.)

Field Details

isAccepted

public final boolean isAccepted

Indicates whether this status represents a successful agreement acceptance. true if the agreement is accepted (either just now or previously), false otherwise.

Method Details

values

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