com.objectxp.msg
Class UcpStatus

java.lang.Object
  com.objectxp.msg.UcpStatus

All Implemented Interfaces:

SmsStatus, java.io.Serializable

public class UcpStatus
extends java.lang.Object
implements SmsStatus

This class represents a UCP Status Report result.

See Also:

Serialized Form

Field Summary

static int	STATUS_DELETE Delete status
static int	STATUS_DELIVERY Delivery status
static int	STATUS_INQUIRY Inquiry status

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.
java.lang.String	getMessage() Gets the system message sent by the SMSC.
int	getReasonCode() Gets the reason code of the SMSC.
int	getType() Gets the type of this status.
boolean	isBuffered() Check if the Message has been sent buffered.
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

STATUS_DELIVERY

public static final int STATUS_DELIVERY

Delivery status

See Also:

Constant Field Values

STATUS_INQUIRY

public static final int STATUS_INQUIRY

Inquiry status

See Also:

Constant Field Values

STATUS_DELETE

public static final int STATUS_DELETE

Delete status

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

isBuffered

public boolean isBuffered()

Check if the Message has been sent buffered.

Returns:

true, when the message has been buffered.

getReasonCode

public int getReasonCode()

Gets the reason code of the SMSC.

Returns:

a reason code, for additional information.

getType

public int getType()

Gets the type of this status.

Returns:

one of STATUS_DELIVERY, STATUS_INQUIRY, STATUS_DELETE

getMessage

public java.lang.String getMessage()

Gets the system message sent by the SMSC.

Returns:

the system message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a String representation.

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