Package com.microstrategy.web.objects
Interface WebSubscriptionRecipient
-
- All Known Subinterfaces:
WebSubscriptionRecipientEmail
public interface WebSubscriptionRecipient
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebSubscriptionContact
getContact()
Returns theWebSubscriptionContact
that is the recipient of the subscriptionWebSubscriptionLocation
getLocation()
Returns theWebSubscriptionLocation
of the recipient.java.lang.String
getSubscriptionID()
Returns the ID of the child subscription for this recipient.boolean
isDefaultLocation()
Returns whether the location is 'transient'.boolean
isUserDefaultContact()
Returns whether the recipient is the default contact of the user whose session is current
-
-
-
Method Detail
-
getLocation
WebSubscriptionLocation getLocation()
Returns theWebSubscriptionLocation
of the recipient. Used mainly in subscriptions of typeEnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeFile
andEnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypePrinter
-
getContact
WebSubscriptionContact getContact()
Returns theWebSubscriptionContact
that is the recipient of the subscription
-
getSubscriptionID
java.lang.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
-
isUserDefaultContact
boolean isUserDefaultContact() throws WebObjectsException
Returns whether the recipient is the default contact of the user whose session is current- Throws:
WebObjectsException
-
isDefaultLocation
boolean isDefaultLocation() throws WebObjectsException
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
-
-