com.objectxp.msg
Class Cimd2Status

java.lang.Object
  com.objectxp.msg.Cimd2Status

All Implemented Interfaces:

SmsStatus, java.io.Serializable

public class Cimd2Status
extends java.lang.Object
implements SmsStatus

This class is a representation of a CIMD2 Status Report Operation (23). It is used in conjunction with SMS-Status reports.

See Also:

SmsMessage.requestStatusReport(boolean), StatusReportMessage.getStatus(), Serialized Form

Field Summary

static int	SC_DELIVERY_FAILED
static int	SC_DELIVERY_SUCCESSFUL
static int	SC_IN_PROCESS
static int	SC_LAST_NO_RESPONSE
static int	SC_MESSAGE_CANCELLED
static int	SC_MESSAGE_DELETED
static int	SC_MESSAGE_DELETED_BY_CANCEL
static int	SC_NO_RESPONSE
static int	SC_NO_STATUS_AVAILABLE
static int	SC_VALIDITY_PERIOD_EXPIRED

Method Summary

java.util.Date	getDischargeTime() Get the time at which a previously submitted SMS was successfully delivered to or attempted to deliver to the recipient or disposed of by the SMSC.
int	getErrorCode() Returns the value of the CIMD2 Status Error Code parameter (ID 62).
int	getStatusCode() Returns the value of the CIMD2 status code parameter (ID 61).
boolean	isCancelled() Returns true if the indicated message has been cancelled by a previous call to SmsService.cancel(Message).
boolean	isDeleted() Returns true if the indicated message has been deleted.
boolean	isDelivered() Check if the Message has been sent sucessfuly.
boolean	isPermanentError() Returns true if a permanent error has occured.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SC_NO_STATUS_AVAILABLE

public static final int SC_NO_STATUS_AVAILABLE

See Also:

Constant Field Values

SC_IN_PROCESS

public static final int SC_IN_PROCESS

See Also:

Constant Field Values

SC_VALIDITY_PERIOD_EXPIRED

public static final int SC_VALIDITY_PERIOD_EXPIRED

See Also:

Constant Field Values

SC_DELIVERY_FAILED

public static final int SC_DELIVERY_FAILED

See Also:

Constant Field Values

SC_DELIVERY_SUCCESSFUL

public static final int SC_DELIVERY_SUCCESSFUL

See Also:

Constant Field Values

SC_NO_RESPONSE

public static final int SC_NO_RESPONSE

See Also:

Constant Field Values

SC_LAST_NO_RESPONSE

public static final int SC_LAST_NO_RESPONSE

See Also:

Constant Field Values

SC_MESSAGE_CANCELLED

public static final int SC_MESSAGE_CANCELLED

See Also:

Constant Field Values

SC_MESSAGE_DELETED

public static final int SC_MESSAGE_DELETED

See Also:

Constant Field Values

SC_MESSAGE_DELETED_BY_CANCEL

public static final int SC_MESSAGE_DELETED_BY_CANCEL

See Also:

Constant Field Values

Method Detail

isDelivered

public boolean isDelivered()

Description copied from interface: SmsStatus

Check if the Message has been sent sucessfuly.

Specified by:

isDelivered in interface SmsStatus

Returns:

true if the message has been delivered, false otherwise.

isPermanentError

public boolean isPermanentError()

Description copied from interface: SmsStatus

Returns true if a permanent error has occured. The SMSC will stop trying to deliver the Message.

Specified by:

isPermanentError in interface SmsStatus

getStatusCode

public int getStatusCode()

Returns the value of the CIMD2 status code parameter (ID 61).

Returns:

int one of the SC_ values.

getErrorCode

public int getErrorCode()

Returns the value of the CIMD2 Status Error Code parameter (ID 62). See the CIMD2 specification (Status code error values) for a list of possible return values.

getDischargeTime

public java.util.Date getDischargeTime()

Description copied from interface: SmsStatus

Get the time at which a previously submitted SMS was successfully delivered to or attempted to deliver to the recipient or disposed of by the SMSC.

Specified by:

getDischargeTime in interface SmsStatus

Returns:

the discharge time or null if not known

isCancelled

public boolean isCancelled()

Description copied from interface: SmsStatus

Returns true if the indicated message has been cancelled by a previous call to SmsService.cancel(Message).

Specified by:

isCancelled in interface SmsStatus

isDeleted

public boolean isDeleted()

Description copied from interface: SmsStatus

Returns true if the indicated message has been deleted.

Specified by:

isDeleted in interface SmsStatus

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object