org.cyclos.model.messaging.sms

Enum OutboundSmsStatus

java.lang.Object

java.lang.Enum<OutboundSmsStatus>

org.cyclos.model.messaging.sms.OutboundSmsStatus

All Implemented Interfaces:

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

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

Contains the possible statuses for an outbound SMS message

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
GATEWAY_UNREACHABLE Network problem, or gateway server down
INVALID The parameters for sending an SMS message were invalid
MAX_GLOBAL_MESSAGES_REACHED The message was not sent, as the maximum SMS messages for a configuration have been reached
MAX_UNREGISTERED_MESSAGES_REACHED The message was not sent, as the maximum SMS messages for a particular unregistered mobile phone have been reached
MAX_USER_MESSAGES_REACHED The message was not sent, as the maximum SMS messages for a particular user have been reached
REJECTED The gateway has rejected the SMS sending
SUCCESS The SMS message was successfully sent
TIMEOUT Timeout while waiting for a server reply
UNKNOWN_ERROR There was an unhandled error

Method Summary

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

SUCCESS

public static final OutboundSmsStatus SUCCESS

The SMS message was successfully sent

INVALID

public static final OutboundSmsStatus INVALID

The parameters for sending an SMS message were invalid

MAX_USER_MESSAGES_REACHED

public static final OutboundSmsStatus MAX_USER_MESSAGES_REACHED

The message was not sent, as the maximum SMS messages for a particular user have been reached

MAX_UNREGISTERED_MESSAGES_REACHED

public static final OutboundSmsStatus MAX_UNREGISTERED_MESSAGES_REACHED

The message was not sent, as the maximum SMS messages for a particular unregistered mobile phone have been reached

MAX_GLOBAL_MESSAGES_REACHED

public static final OutboundSmsStatus MAX_GLOBAL_MESSAGES_REACHED

The message was not sent, as the maximum SMS messages for a configuration have been reached

GATEWAY_UNREACHABLE

public static final OutboundSmsStatus GATEWAY_UNREACHABLE

Network problem, or gateway server down

TIMEOUT

public static final OutboundSmsStatus TIMEOUT

Timeout while waiting for a server reply

REJECTED

public static final OutboundSmsStatus REJECTED

The gateway has rejected the SMS sending

UNKNOWN_ERROR

public static final OutboundSmsStatus UNKNOWN_ERROR

There was an unhandled error

Method Detail

values

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

Returns:

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

valueOf

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