public interface

WebSubscriptionAddress

implements Persistable EditableObject WebSubscriptionComponent
com.microstrategy.web.objects.WebSubscriptionAddress

Class Overview

This object represents a user's address that is used for Narrowcast subscription.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract int getDeliveryMode()
abstract String getDeliveryWindow()
returns the String form of the delivery window associated with this address.
abstract WebSubscriptionDevice getDevice()
abstract String getPIN()
returns the PIN associated with this address
abstract SimpleList getSubscriptions(int blockBegin, int blockCount)
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.
abstract SimpleList getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects which use this particular address, from a specified begin block, up to a specified block count.
abstract SimpleList getSubscriptions()
Returns a SimpleList collection of WebSubscription objects to which this address is subscribed to
abstract String getTranspropsID()
returns the ID of the transmission properties associated with this address
abstract String getValue()
abstract boolean isDefault()
abstract boolean isNew()
abstract void setContact(String contactID)
set contact Id address relates to
abstract void setDefault(boolean def)
Used to change the default status of the address
abstract void setDefault()
This method is deprecated. see setDefault(boolean)
abstract void setDeliveryMode(int deliveryType)
set delivery mode of address
abstract void setDeliveryWindow(String dWindow)
sets the String form of the delivery window associated with this address
abstract void setDevice(WebSubscriptionDevice device)
sets the WebSubscriptionDevice object associated with this address.
abstract void setDevice(String deviceID)
sets the deviceID associated with this address.
abstract void setName(String name)
sets the name of the address object
abstract void setPIN(String pin)
sets the PIN associated with this address.
abstract void setValue(String addressValue)
sets the physical value of the address.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.EditableObject
From interface com.microstrategy.web.objects.WebSubscriptionComponent

Public Methods

public abstract int getDeliveryMode ()

Returns

public abstract 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

public abstract WebSubscriptionDevice getDevice ()

Returns
Throws
WebObjectsException Thrown if there is an error retrieving device information corresponding to this addressID.

public abstract String getPIN ()

returns the PIN associated with this address

Returns
  • the PIN

public abstract SimpleList getSubscriptions (int blockBegin, int blockCount)

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
WebObjectsException

public abstract SimpleList getSubscriptions (WebSubscriptionsFilter filter, int blockBegin, int blockCount)

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 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
Throws
WebObjectsException
WebObjectsException

public abstract SimpleList getSubscriptions ()

Returns a SimpleList collection of WebSubscription objects to which this address is subscribed to

Throws
WebObjectsException
WebObjectsException

public abstract String getTranspropsID ()

returns the ID of the transmission properties associated with this address

Returns
  • transmission properties ID

public abstract String getValue ()

Returns
  • the physical value of the address

public abstract boolean isDefault ()

Returns
  • boolean value indicating whether this is the default address for the user

public abstract boolean isNew ()

Returns
  • whether this a new address, i.e. not yet saved.

public abstract void setContact (String contactID)

set contact Id address relates to

public abstract void setDefault (boolean def)

Used to change the default status of the address

public abstract void setDefault ()

This method is deprecated.
see setDefault(boolean)

sets this address as the default address for the user.

public abstract void setDeliveryMode (int deliveryType)

set delivery mode of address

Parameters
deliveryType EnumDSSXMLSubscriptionDeliveryType

public abstract void setDeliveryWindow (String dWindow)

sets the String form of the delivery window associated with this address

Parameters
dWindow the delivery window

public abstract void setDevice (WebSubscriptionDevice device)

sets the WebSubscriptionDevice object associated with this address.

public abstract void setDevice (String deviceID)

sets the deviceID associated with this address.

Parameters
deviceID the deviceID for this address
Throws
WebObjectsException} if the device with the specified ID does not exist
WebObjectsException

public abstract void setName (String name)

sets the name of the address object

public abstract void setPIN (String pin)

sets the PIN associated with this address.

public abstract void setValue (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