net.rim.pushsdk.push
Class CancelOutcome

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

public class CancelOutcome
extends Object

The outcome of a request to cancel a push submission for a particular address.

Author:

mhogan

Constructor Summary

CancelOutcome(String address, StatusCode code, String description)
Constructs the outcome of a cancel 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.
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

CancelOutcome

public CancelOutcome(String address,
                     StatusCode code,
                     String description)

Constructs the outcome of a cancel 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

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, only 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

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.