net.rim.pushsdk.push
Class PushOutcome

java.lang.Object
  net.rim.pushsdk.push.PushOutcome

public class PushOutcome
extends Object

The outcome of a push request for a particular address.

Author:

mhogan

Constructor Summary

PushOutcome(String address, StatusCode code, String description, Date eventTime, MessageState messageState, Boolean applicationReliable)
Constructs the outcome of a push request.

Method Summary
String	getAddress() Gets the address associated with the outcome.
StatusCode	getCode() Gets the status code of the outcome.
String	getDescription() Gets a textual description of the outcome.
Date	getEventTime() Gets the date at which the outcome was decided.
MessageState	getMessageState() Gets the current state of the request.
boolean	isApplicationReliable() Deprecated. As of release 1.1, replaced by isAppReliable().
Boolean	isAppReliable() Whether or not the delivery method of the request was application-level reliable.
String	toString() Constructs a String with all attributes in name = value format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PushOutcome

public PushOutcome(String address,
                   StatusCode code,
                   String description,
                   Date eventTime,
                   MessageState messageState,
                   Boolean applicationReliable)

Constructs the outcome of a push request.

Parameters:

address - the address (subscriber id if subscription is supported)

code - the status code of the outcome

description - a textual description of the outcome

eventTime - the date at which the outcome was decided

messageState - the current state of the request

applicationReliable - whether or not the delivery method of the request was application-level reliable (null is possible for enterprise (BES), since sometimes the delivery method is not always indicated in the outcome)

Method Detail

getAddress

public String getAddress()

Gets the address associated with the outcome. For a public (BIS) push, this would be a subscriber ID. For an enterprise (BES) push, this would be the underlying address, if subscription is being bypassed.

Returns:

the address in the outcome

getCode

public StatusCode getCode()

Gets the status code of the outcome.

Returns:

the response code

getDescription

public String getDescription()

Gets a textual description of the outcome.

Returns:

the textual result of the operation

getEventTime

public Date getEventTime()

Gets the date at which the outcome was decided.

Returns:

the event date

getMessageState

public MessageState getMessageState()

Gets the current state of the request.

Returns:

the current state of the request

isApplicationReliable

@Deprecated
public boolean isApplicationReliable()

Deprecated. As of release 1.1, replaced by isAppReliable().

Whether or not the delivery method of the request was application-level reliable.

Returns:

true if application-level reliability was used; false otherwise

isAppReliable

public Boolean isAppReliable()

Whether or not the delivery method of the request was application-level reliable.

Returns:

true if application-level reliability was used, false if it was not, or null if the application-level reliability used is unknown (this is sometimes the case with enterprise (BES) PPGs)

Since:

1.1

toString

public String toString()

Constructs a String with all attributes in name = value format.

Overrides:

toString in class Object

Returns:

a String representation of this object.