public interface

WebSubscriptionRecipientList

com.microstrategy.web.objects.WebSubscriptionRecipientList

Summary

Public Methods
abstract WebSubscriptionRecipient add(String contactID)
Adds a recipient with the specified contact ID.
abstract WebSubscriptionRecipient addAddress(WebSubscriptionAddress address)
Add a recipient with the specified address object.
abstract WebSubscriptionRecipient addAddress(String addressID)
Adds a recipient with the specified location ID.
abstract WebSubscriptionRecipient addAddress(String contactID, String addressID)
Adds a recipient with the specified contact ID and location ID.
abstract WebSubscriptionRecipient addLocation(String contactID, String locationKey)
Adds a recipient with the specified location key.
abstract WebSubscriptionRecipient addLocation(String locationKey)
Adds a recipient with the specified location ID.
abstract void clear()
clears the recipients list.
abstract SimpleList filterByAddress(String contactID, String addressID)
returns list of recipients that match the contact, address criterions passed.
abstract SimpleList filterByLocation(String contactID, String locationKey)
returns list of recipients that match the contact, location criterions passed.
abstract boolean forceRemoveAddress(String addressID)
Removes the recipient with the specified address ID passed.
abstract WebSubscriptionRecipient get(int index)
Retrieves the recipient from the index passed.
abstract int getChangeableMask()
Gets the changeable mask, from EnumDSSXMLNCSAllowChangeMaskType
abstract boolean remove(String contactID)
removes the recipient with contact ID passed.
abstract boolean remove(WebSubscriptionRecipient recipient)
removes the recipient passed.
abstract boolean removeAddress(String addressID)
Removes the recipient with the specified address ID passed.
abstract boolean removeAddress(String contactID, String addressID)
removes the recipient with contact ID and address ID passed.
abstract boolean removeLocation(String locationKey)
Removes the recipient with the specified location key passed.
abstract boolean removeLocation(String contactID, String locationKey)
removes the recipient with contact ID and locationKey passed.
abstract void setChangeableMask(int mask)
Sets the changeable mask, from EnumDSSXMLNCSAllowChangeMaskType.
abstract void setIsAllConsumers(int isAllConsumers)
sets a flag to indicate an isAllConsumers selected in cache subscription
abstract void setIsBursting()
sets a flag to indicate an instance of burst email subscription
abstract int size()
returns the size of the recipients list.

Public Methods

public abstract WebSubscriptionRecipient add (String contactID)

Adds a recipient with the specified contact ID. The location is the default location defined for that contact.

Parameters
contactID DSS ID of the contact which needs to be added as a recipient

public abstract WebSubscriptionRecipient addAddress (WebSubscriptionAddress address)

Add a recipient with the specified address object.

public abstract WebSubscriptionRecipient addAddress (String addressID)

Adds a recipient with the specified location ID. The recipient is the default contact associated with the current user who makes the subscription

Parameters
addressID DSS ID of the location to which the subscription is sent
Throws
WebObjectsException

public abstract WebSubscriptionRecipient addAddress (String contactID, String addressID)

Adds a recipient with the specified contact ID and location ID.

Parameters
contactID DSS ID of the contact which needs to be added as a recipient
Throws
WebObjectsException

public abstract WebSubscriptionRecipient addLocation (String contactID, String locationKey)

Adds a recipient with the specified location key.

Throws
WebObjectsException

public abstract WebSubscriptionRecipient addLocation (String locationKey)

Adds a recipient with the specified location ID. The recipient is the default contact associated with the current user who makes the subscription

Parameters
locationKey DSS ID of the location to which the subscription is sent
Throws
WebObjectsException

public abstract void clear ()

clears the recipients list.

public abstract SimpleList filterByAddress (String contactID, String addressID)

returns list of recipients that match the contact, address criterions passed. If contactID is passed null or empty, the address is looked up in the personal recipients.

public abstract SimpleList filterByLocation (String contactID, String locationKey)

returns list of recipients that match the contact, location criterions passed. If contactID is passed null or empty, the location is looked up in the personal recipients.

public abstract boolean forceRemoveAddress (String addressID)

Removes the recipient with the specified address ID passed. The recipient is the default contact associated with the current user who makes the subscription. If there are multiple matching instances, the first one encountered will be removed.

public abstract WebSubscriptionRecipient get (int index)

Retrieves the recipient from the index passed.

public abstract int getChangeableMask ()

Gets the changeable mask, from EnumDSSXMLNCSAllowChangeMaskType

public abstract boolean remove (String contactID)

removes the recipient with contact ID passed. Note, if there are multiple recipients with the same contact ID, this API will remove the one which for which the address is transient (in other words, for which the address is not marked to use the default address). If there are multiple instances of such contact, the first one encountered will be removed.

public abstract boolean remove (WebSubscriptionRecipient recipient)

removes the recipient passed.

Parameters
recipient to be removed.

public abstract boolean removeAddress (String addressID)

Removes the recipient with the specified address ID passed. The recipient is the default contact associated with the current user who makes the subscription. If there are multiple matching instances, the first one encountered will be removed.

public abstract boolean removeAddress (String contactID, String addressID)

removes the recipient with contact ID and address ID passed. If there are multiple instances of such contact, the first one encountered will be removed.

public abstract boolean removeLocation (String locationKey)

Removes the recipient with the specified location key passed. The recipient is the default contact associated with the current user who makes the subscription. If there are multiple matching instances, the first one encountered will be removed.

public abstract boolean removeLocation (String contactID, String locationKey)

removes the recipient with contact ID and locationKey passed. If there are multiple instances of such contact, the first one encountered will be removed.

public abstract void setChangeableMask (int mask)

Sets the changeable mask, from EnumDSSXMLNCSAllowChangeMaskType. This enables the creator of the subscription to specify whether the recipients are allowed to change personalization, delivery settings or unsubscribe.

public abstract void setIsAllConsumers (int isAllConsumers)

sets a flag to indicate an isAllConsumers selected in cache subscription

public abstract void setIsBursting ()

sets a flag to indicate an instance of burst email subscription

public abstract int size ()

returns the size of the recipients list.