net.rim.pushsdk.push
Class CancelResult

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

public class CancelResult
extends Object

Represents the result of a cancel including the response from the PPG and sets of subscriber ids that were not sent to the PPG because they were invalid in some way (i.e. they do not exist, are inactive, or are suspended at the time of the cancel request).

Note: The three invalid subscriber sets are populated only if addresses were provided in the request and the push service is not storing push requests.

Author:

mdicesare

Constructor Summary

CancelResult(String pushId)
Constructs a cancel result with the given push id.

Method Summary
protected void	addOutcome(String address, StatusCode code, String description) Adds an outcome to the cancel result.
Set<String>	getDoNotExistSubscriberIds() Returns the collection of subscriber ids that could not be found in storage.
Set<String>	getInactiveSubscriberIds() Returns the collection of subscriber ids that match inactive subscribers.
List<CancelOutcome>	getOutcomes() Returns the address-specific push outcomes.
String	getPushId() Gets the id of the push that was associated with the cancel attempt.
Set<String>	getSuspendedSubscriberIds() Returns the collection of subscriber ids that match suspended subscribers.
void	setDoNotExistSubscriberIds(Set<String> doNotExistSubscriberIds) Sets the collection of subscriber ids that could not be found in storage.
void	setInactiveSubscriberIds(Set<String> inactiveSubscriberIds) Sets the collection of subscriber ids that match inactive subscribers.
void	setSuspendedSubscriberIds(Set<String> suspendedSubscriberIds) Sets the collection of subscriber ids that match suspended subscribers.
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

CancelResult

public CancelResult(String pushId)

Constructs a cancel result with the given push id.

Parameters:

pushId - the id of a push

Method Detail

getPushId

public String getPushId()

Gets the id of the push that was associated with the cancel attempt.

Returns:

the id of a push

getOutcomes

public List<CancelOutcome> getOutcomes()

Returns the address-specific push outcomes. If the address is null, then the outcome pertains to all addresses for the request.

Returns:

a list of outcomes

addOutcome

protected void addOutcome(String address,
                          StatusCode code,
                          String description)

Adds an outcome to the cancel result.

Parameters:

address - the address associated with the outcome. If the outcome pertains to all addresses, this address would be null. For a public (BIS) push, the address corresponds to a subscriber ID. For an enterprise (BES) push, this would be the underlying address, if subscription is being bypassed.

code - the status code associated with the outcome

description - the textual description of the outcome

setDoNotExistSubscriberIds

public void setDoNotExistSubscriberIds(Set<String> doNotExistSubscriberIds)

Sets the collection of subscriber ids that could not be found in storage.

Parameters:

doNotExistSubscriberIds - a collection of ids for non-existent subscribers

getDoNotExistSubscriberIds

public Set<String> getDoNotExistSubscriberIds()

Returns the collection of subscriber ids that could not be found in storage.

Returns:

the collection of ids for non-existent subscribers

setInactiveSubscriberIds

public void setInactiveSubscriberIds(Set<String> inactiveSubscriberIds)

Sets the collection of subscriber ids that match inactive subscribers.

Parameters:

inactiveSubscriberIds - a collection of ids for inactive subscribers

getInactiveSubscriberIds

public Set<String> getInactiveSubscriberIds()

Returns the collection of subscriber ids that match inactive subscribers.

Returns:

the collection of ids for inactive subscribers

setSuspendedSubscriberIds

public void setSuspendedSubscriberIds(Set<String> suspendedSubscriberIds)

Sets the collection of subscriber ids that match suspended subscribers.

Parameters:

suspendedSubscriberIds - a collection of ids for suspended subscribers

getSuspendedSubscriberIds

public Set<String> getSuspendedSubscriberIds()

Returns the collection of subscriber ids that match suspended subscribers.

Returns:

the collection of ids for suspended subscribers

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.