Package com.microstrategy.web.objects

Interface WebSubscriptionRecipientList

  • public interface WebSubscriptionRecipientList
    Since:
    MicroStrategy Web 9.0.0

    • Method Detail

      • size

        int size()
        returns the size of the recipients list.

      • remove

        boolean remove​(java.lang.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.
        Parameters:
        contactID -

      • remove

        boolean remove​(WebSubscriptionRecipient recipient)
        removes the recipient passed.
        Parameters:
        recipient - to be removed.

      • removeAddress

        boolean removeAddress​(java.lang.String contactID,
                      java.lang.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.
        Parameters:
        contactID -
        addressID -

      • removeAddress

        boolean removeAddress​(java.lang.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.
        Parameters:
        addressID -

      • forceRemoveAddress

        boolean forceRemoveAddress​(java.lang.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.
        Parameters:
        addressID -

      • removeLocation

        boolean removeLocation​(java.lang.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.
        Parameters:
        locationKey -

      • removeLocation

        boolean removeLocation​(java.lang.String contactID,
                       java.lang.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.
        Parameters:
        contactID -
        locationKey -

      • setChangeableMask

        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.
        Parameters:
        mask -

      • add

        WebSubscriptionRecipient add​(java.lang.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

      • addAddress

        WebSubscriptionRecipient addAddress​(java.lang.String contactID,
                                    java.lang.String addressID)
                             throws WebObjectsException
        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
        locationID - DSS ID of the location to which the subscription is sent
        Throws:
        WebObjectsException

      • addAddress

        WebSubscriptionRecipient addAddress​(java.lang.String addressID)
                             throws WebObjectsException
        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

      • addLocation

        WebSubscriptionRecipient addLocation​(java.lang.String locationKey)
                              throws WebObjectsException
        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

      • filterByAddress

        SimpleList filterByAddress​(java.lang.String contactID,
                           java.lang.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.
        Parameters:
        contactID -
        addressID -

      • filterByLocation

        SimpleList filterByLocation​(java.lang.String contactID,
                            java.lang.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.
        Parameters:
        contactID -
        locationKey -

      • clear

        void clear()
        clears the recipients list.

      • setIsBursting

        void setIsBursting()
        sets a flag to indicate an instance of burst email subscription

      • setIsAllConsumers

        void setIsAllConsumers​(int isAllConsumers)
        sets a flag to indicate an isAllConsumers selected in cache subscription