Package com.microstrategy.web.objects

Interface WebSubscriptionAddress

    • Method Detail

      • setDevice

        void setDevice​(java.lang.String deviceID)
        throws WebObjectsException
        sets the deviceID associated with this address.
        Parameters:
        deviceID - the deviceID for this address
        Throws:
        WebObjectsException

      • setDefault

        void setDefault()
        Deprecated.
        see setDefault(boolean)
        sets this address as the default address for the user.

      • setDefault

        void setDefault​(boolean def)
        Used to change the default status of the address
        Parameters:
        def -

      • getTranspropsID

        java.lang.String getTranspropsID()
        returns the ID of the transmission properties associated with this address
        Returns:
        transmission properties ID

      • getDeliveryWindow

        java.lang.String getDeliveryWindow()
        returns the String form of the delivery window associated with this address. delivery window defines what times of the week a delivery should be made
        Returns:
        the delivery window string

      • setDeliveryWindow

        void setDeliveryWindow​(java.lang.String dWindow)
        sets the String form of the delivery window associated with this address
        Parameters:
        dWindow - the delivery window

      • getPIN

        java.lang.String getPIN()
        returns the PIN associated with this address
        Returns:
        the PIN

      • setPIN

        void setPIN​(java.lang.String pin)
        sets the PIN associated with this address.
        Parameters:
        pin -

      • isDefault

        boolean isDefault()
        Returns:
        boolean value indicating whether this is the default address for the user

      • setValue

        void setValue​(java.lang.String addressValue)
        sets the physical value of the address. For instance, for an address of type email, the value would be something like 'test@test.com'
        Parameters:
        addressValue - the string representing the physical address

      • setName

        void setName​(java.lang.String name)
        sets the name of the address object
        Parameters:
        name -

      • getValue

        java.lang.String getValue()
        Returns:
        the physical value of the address

      • isNew

        boolean isNew()
        Returns:
        whether this a new address, i.e. not yet saved.
        Since:
        MicroStrategy Web 8.0.1

      • getSubscriptions

        SimpleList getSubscriptions​(int blockBegin,
                            int blockCount)
                     throws WebObjectsException
        Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.
        Parameters:
        blockBegin - , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
        blockCount - , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 9.0.0

      • getSubscriptions

        SimpleList getSubscriptions​(WebSubscriptionsFilter filter,
                            int blockBegin,
                            int blockCount)
                     throws WebObjectsException
        Returns a SimpleList collection of WebSubscription objects which use this particular address, from a specified begin block, up to a specified block count. The results are filtered by the specified filter
        Parameters:
        filter - WebSubscriptionsFilter to filter results. A blank filter can be retrieved from WebSubscriptionsSource.getNewSubscriptionsFilter(). The filter's delivery mode will be overwritten with the addresses delivery mode
        blockBegin - , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
        blockCount - , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
        Returns:
        SimpleList collection of filtered WebSubscription objects
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 9.0.0

      • setContact

        void setContact​(java.lang.String contactID)
        set contact Id address relates to
        Parameters:
        contactID -