WebSubscriptionRecipient
| com.microstrategy.web.objects.WebSubscriptionRecipient |
 Known Indirect Subclasses
|
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebSubscriptionContact |
getContact()
Returns the
WebSubscriptionContact that is the recipient
of the subscription
| ||||||||||
| abstract WebSubscriptionLocation |
getLocation()
Returns the
WebSubscriptionLocation of the recipient. | ||||||||||
| abstract String |
getSubscriptionID()
Returns the ID of the child subscription for this recipient.
| ||||||||||
| abstract boolean |
isDefaultLocation()
Returns whether the location is 'transient'.
| ||||||||||
| abstract boolean |
isUserDefaultContact()
Returns whether the recipient is the default contact of the user whose session is current
| ||||||||||
Public Methods
public abstract WebSubscriptionContact getContact ()
Returns the WebSubscriptionContact that is the recipient
of the subscription
public abstract WebSubscriptionLocation getLocation ()
Returns the WebSubscriptionLocation of the recipient.
Used mainly in subscriptions of type DssXmlDeliveryTypeFile and
DssXmlDeliveryTypePrinter
public abstract String getSubscriptionID ()
Returns the ID of the child subscription for this recipient. When a multi-recipient subscription is created, there is one parent subscription and several child subscriptions - one for each recipient. Using the ID of the child subscription, we can obtain the child subscription alone
public abstract boolean isDefaultLocation ()
Returns whether the location is 'transient'. When a contact is subscribed to a subscription and saved, the Intelligence server will return the address/location that is the default location/address of the contact. Since this can change with time, we call this 'transient'
Throws
| WebObjectsException |
|---|
public abstract boolean isUserDefaultContact ()
Returns whether the recipient is the default contact of the user whose session is current
Throws
| WebObjectsException |
|---|