public final class DBCMessageSendStatusType
extends java.lang.Object
An instance of this class represents the status of the send of a single (possibly-concatenated) message.
If the message is a concatenated message, this result is the least-common-denominator of the send of all its parts, ie, if 2 parts are Sent successfully, and one is Error, the total result will be termed as an Error.
This class also includes user-friendly string values of each of the types, as a convenience to the developer.
Instances of this class cannot be created. Only references to the static values defined in this class should be used, for example,
if(status==DBCMessageSendStatusType.Sent)
{
...do something
}
Modifier and Type | Field and Description |
---|---|
static DBCMessageSendStatusType |
Failed
This result means that the message send failed, and should not be retried.
|
static DBCMessageSendStatusType |
InQueue
This result means that the message send failed, but the message should be placed back into the queue.
|
static DBCMessageSendStatusType |
RetryQueue
This result means that the message send failed, but the message should be placed back into the queue.
|
static DBCMessageSendStatusType |
Sent
This result means that the message send was successful.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
Gets the user-friendly name of this type.
|
java.lang.String |
toDBVal()
Gets a single-character representation of the type.
|
public static final DBCMessageSendStatusType InQueue
If a try-limit is being used, it should not be incremented.
public static final DBCMessageSendStatusType RetryQueue
If a try-limit is being used, it should be incremented.
public static final DBCMessageSendStatusType Sent
public static final DBCMessageSendStatusType Failed
public java.lang.String toDBVal()
public java.lang.String getName()
This should be used only for display purposes, and never for comparison.