io.mosip.kernel.auth.constant

Enum OTPErrorCode

java.lang.Object

java.lang.Enum<OTPErrorCode>

io.mosip.kernel.auth.constant.OTPErrorCode

All Implemented Interfaces:

Serializable, Comparable<OTPErrorCode>

public enum OTPErrorCode
extends Enum<OTPErrorCode>

Author:

Ramadurai Pandian

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMAILNOTCONFIGURED EMAIL not configured
EMAILNOTREGISTERED Email not registered
EMAILPHONENOTREGISTERED Email and Phone not registered
EMAILSMSNOTCONFIGURED EMAIL and SMS not configured
LANGUAGENOTCONFIGURED User blocked
PHONENOTREGISTERED Phone Number not registered
SMSNOTCONFIGURED SMS not configured
UNABLETOSENDNOTIFICATION EMAIL and SMS not configured
USERBLOCKED User blocked

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Function to get error code
String	getErrorMessage() Function to get the error message
static OTPErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OTPErrorCode[]	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

PHONENOTREGISTERED

public static final OTPErrorCode PHONENOTREGISTERED

Phone Number not registered

EMAILNOTREGISTERED

public static final OTPErrorCode EMAILNOTREGISTERED

Email not registered

EMAILPHONENOTREGISTERED

public static final OTPErrorCode EMAILPHONENOTREGISTERED

Email and Phone not registered

SMSNOTCONFIGURED

public static final OTPErrorCode SMSNOTCONFIGURED

SMS not configured

EMAILNOTCONFIGURED

public static final OTPErrorCode EMAILNOTCONFIGURED

EMAIL not configured

EMAILSMSNOTCONFIGURED

public static final OTPErrorCode EMAILSMSNOTCONFIGURED

EMAIL and SMS not configured

UNABLETOSENDNOTIFICATION

public static final OTPErrorCode UNABLETOSENDNOTIFICATION

EMAIL and SMS not configured

USERBLOCKED

public static final OTPErrorCode USERBLOCKED

User blocked

LANGUAGENOTCONFIGURED

public static final OTPErrorCode LANGUAGENOTCONFIGURED

User blocked

Method Detail

values

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

Returns:

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

valueOf

public static OTPErrorCode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getErrorCode

public String getErrorCode()

Function to get error code

Returns:

errorCode

getErrorMessage

public String getErrorMessage()

Function to get the error message

Returns:

errorMessager