net.rim.pushsdk.subscription
Class SubscriptionValidationResult

java.lang.Object
  extended by net.rim.pushsdk.subscription.SubscriptionValidationResult
All Implemented Interfaces:
Serializable

public class SubscriptionValidationResult
extends Object
implements Serializable

Encapsulates the results of subscription validation including the collection of subscribers ids that do not exist, the collection of inactive subscriber ids, the collection of suspended subscriber ids, and the collection of addresses (e.g. PIN, email address) for the active subscribers.

For each collection, any duplicates will have been removed.

Author:
mdicesare
See Also:
Serialized Form

Constructor Summary
SubscriptionValidationResult()
          Constructs a new subscription validation result object.
 
Method Summary
 Set<String> getActiveAddresses()
          Returns the collection of active addresses.
 Set<SubscriberPartial> getActiveSubscribers()
          Returns the collection of active subscribers.
 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.
 Set<String> getSuspendedSubscriberIds()
          Returns the collection of subscriber ids that match suspended subscribers.
 void setActiveAddresses(Set<String> activeAddresses)
          Sets the collection of active addresses.
 void setActiveSubscribers(Set<SubscriberPartial> activeSubscribers)
          Sets the collection of active 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubscriptionValidationResult

public SubscriptionValidationResult()
Constructs a new subscription validation result object. Setters must be called to initialize the various collections of subscriber ids and addresses.

Method Detail

getActiveAddresses

public Set<String> getActiveAddresses()
Returns the collection of active addresses.

Returns:
the collection of active addresses; empty collection if there are none

setActiveAddresses

public void setActiveAddresses(Set<String> activeAddresses)
Sets the collection of active addresses.

Parameters:
activeAddresses - a collection of active addresses

getActiveSubscribers

public Set<SubscriberPartial> getActiveSubscribers()
Returns the collection of active subscribers.

Returns:
the collection of active subscribers; empty collection if there are none

setActiveSubscribers

public void setActiveSubscribers(Set<SubscriberPartial> activeSubscribers)
Sets the collection of active subscribers.

Parameters:
activeSubscribers - a collection of active subscribers

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


Copyright © 2011 Research In Motion. All Rights Reserved.