Package com.microstrategy.web.objects
Interface WebSubscription
-
- All Superinterfaces:
EditableObject
,EnumWebPersistableState
,Persistable
,StringKey
,WebSubscriptionComponent
,WebSubscriptionProperties
public interface WebSubscription extends WebSubscriptionProperties, WebSubscriptionComponent, EditableObject, Persistable
This interface represents a Subscription to scheduled reports- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addContentPls(java.lang.String key, WebContentPersonalization lContentPls)
Set content personalization to the map MapcontentPls, key is content id defined by XMLTags.Att_CnID in the subscription for get subscriptions. WebSubscriptionAddress
getAddress()
java.lang.String
getBurstAddressAttributeId()
gets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.java.lang.String
getBurstDeviceId()
sets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.java.lang.String
getBurstFormId()
gets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.java.lang.String
getBurstLayoutKey()
gets the layout key that contains the attribute.java.util.ArrayList
getBurstList()
WebSubscriptionContent
getContent()
This API is only available with valid information for single content subscriptionWebSubscriptionContent
getContent(int index)
This API is only available with valid information for multiple content subscriptionWebObjectInfo
getContentForAlert()
Returns the report that has been configured to be delivered for the alert.java.util.List<WebSubscriptionContent>
getContentList()
Get the content list of the subscriptionWebContentPersonalization
getContentPersonalizationByContentIndex(int index)
Get the content personalization by the content index This API is only available with valid information for multiple content subscriptionjava.util.Map<java.lang.String,WebContentPersonalization>
getContentPls()
Get the map contains the content personalization of all the contents This API is only available with valid information for multiple content subscriptionWebContentPersonalization
getContentPlsByKey(java.lang.String key)
Get content personalization from the map MapcontentPls, key is content id defined by XMLTags.Att_CnID in the subscription for get subscriptions. java.util.List<WebSubscriptionContent>
getContents()
Get the content list of the subscription The usage of the API would actually needs WebIServerSubscriptionContentResultSetImpl in many casesWebSubscriptionEMMACubeOptions
getEMMACubeOptions()
Returns the associateWebSubscriptionEMMACubeOptions
interface which represent the EMMA cube related options for this subscription This API is only available with valid information for single content subscriptionboolean
getIncludePrompts()
WebInstancePersonalization
getInstancePersonalization()
Get instance personalization from a multiple content subscription.boolean
getIsMCS()
Get a multiple content subscription to be true, by default it is false - for single content subscriptionWebSubscriptionLocation
getLocation()
Retrieves theWebSubscriptionLocation
associated with this subscriptionWebSubscriptionNotification
getNotification()
Retrieves theWebSubscriptionNotification
object that can edited to specify whether any notification mechanism should be specified while creating the subscription.WebSubscriptionEMMACubeOptions
getOrCreateEMMACubeOptions()
Returns the associateWebSubscriptionEMMACubeOptions
interface which represent the EMMA cube related options for this subscription, if it was not create yet this function will create and return it.WebUserEntity
getOwner()
This call returns theWebUserEntity
who is the owner of the subscription.java.lang.String
getPromptAnswerXML()
WebSubscriptionRecipientList
getRecipients()
Returns theWebSubscriptionRecipientList
, which is a collection interface ofWebSubscriptionRecipient
objects who are subscribed to the current subscription.java.lang.String
getRecipientSubscriptionIDForPersonalView()
Returns the subscription ID of recipient for personal view subscription.WebIServerSubscriptionTrigger
getSubscriptionTrigger()
Return theWebIServerSubscriptionTrigger
associated with this subscription.int
getSubscriptionType()
Returns the type of the subscription, fromEnumDSSXMLNCSSubscriptionType
.WebSubscriptionTrigger
getTrigger()
Deprecated.Please usegetSubscriptionTrigger()
insteadboolean
isAlertingSubscription()
Returnstrue
if the subscription is used to define an alert This API is only available with valid information for single content subscriptionboolean
isInvalidSchedule()
boolean
isNew()
This indicates whether the whether the subscription is a new oneboolean
isPersonalized()
This indicates whether the content that we are creating a subscription for is promptedboolean
isReuseDataSetCache()
This API is only available with valid information for single content subscriptionvoid
resetRdfMap()
Rest rdf map for update workflow so that the rdf map gets cleaned up to populate updated informationvoid
restContentAndPersonalization()
Reset the contents and associated personalization to be empty This API is only available with valid information for multiple content subscriptionvoid
setAddress(WebSubscriptionAddress address)
Sets theWebSubscriptionAddress
to be associated with this subscriptionvoid
setAlertingSubscription(boolean val)
Sets the subscription to be an alerting subscription.void
setBurstAddressAttributeId(java.lang.String burstAddressID)
sets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.void
setBurstDeviceId(java.lang.String burstDeviceID)
gets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.void
setBurstFormId(java.lang.String burstFormID)
sets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.void
setBurstLayoutKey(java.lang.String burstLayoutKey)
sets the layout key that contains the attribute.void
setBurstList(java.util.ArrayList burstList)
WebSubscriptionContent
setContent(WebObjectInfo woi)
sets the content for this subscription This API is only available with valid information for single content subscriptionvoid
setContent(WebResultSetInstance instance)
Sets the content of this subscription based on an existing instance.void
setContentForAlert(WebObjectInfo woi)
Sets the report that needs to be delivered when an alerting condition is met.void
setContentMCS(WebResultSetInstance instance, int index)
Sets the content of this subscription based on an existing instance.WebSubscriptionContent
setContents(WebObjectInfo woi, int index)
sets the contents for this multiple content subscription This API is only available with valid information for multiple content subscriptionvoid
setDeliveryMode(int deliveryMode)
Sets delivery mode.void
setIncludePrompts(boolean value)
void
setInstancePersonalization(WebInstancePersonalization iInstancePls)
Set the instance personalization for a multiple content subscription.void
setIsMCS(boolean isMCS)
Set a multiple content subscription to be true, by default it is false - for single content subscription set _isMCSvoid
setLocation(WebSubscriptionLocation location)
Sets theWebSubscriptionLocation
to be associated with this subscription A location is an abstraction that encomposses either an address or a device and is useful while creating File or Print subscriptions.void
setName(java.lang.String name)
Sets the name of the subscription.void
setOwner(WebUserEntity owner)
Sets the owner of the subscription.void
setReuseDataSetCache(boolean isReuseDataSetCache)
This API is only available with valid information for single content subscriptionvoid
setTrigger(WebSubscriptionTrigger trigger)
Sets theWebSubscriptionTrigger
to be associated with this subscription-
Methods inherited from interface com.microstrategy.web.objects.EditableObject
delete, save, save
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.utils.StringKey
getStringKey
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionComponent
getDescription, getID, getName, getSessionInfo, getType, isPopulated, populate
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionProperties
getBadgeMetricId, getBurstingLowerBound, getBurstingUpperBound, getContentProperties, getContentPropertiesMCS, getCreationTime, getCustomMessage, getDeliveryMode, getModificationTime, isBursting, isPushNotify, isSendNowSet, isUpdateBadge, setBadgeMetricId, setBurstingLowerBound, setBurstingUpperBound, setCustomMessage, setIsBursting, setIsPushNotify, setIsUpdateBadge, setSendNow
-
-
-
-
Method Detail
-
isNew
boolean isNew()
This indicates whether the whether the subscription is a new one- Returns:
- boolean value indicating whether the subscription is new
- Since:
- MicroStrategy Web 9.0.0
-
getTrigger
WebSubscriptionTrigger getTrigger() throws WebObjectsException
Deprecated.Please usegetSubscriptionTrigger()
instead- Returns:
- the
WebSubscriptionTrigger
associated with this subscription - Throws:
WebObjectsException
-
getSubscriptionTrigger
WebIServerSubscriptionTrigger getSubscriptionTrigger() throws WebObjectsException
Return theWebIServerSubscriptionTrigger
associated with this subscription.- Returns:
- the
WebIServerSubscriptionTrigger
associated with this subscription - Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
setTrigger
void setTrigger(WebSubscriptionTrigger trigger)
Sets theWebSubscriptionTrigger
to be associated with this subscription
-
getAddress
WebSubscriptionAddress getAddress() throws WebObjectsException
- Returns:
- the
WebSubscriptionAddress
associated with this subscription - Throws:
WebObjectsException
-
setAddress
void setAddress(WebSubscriptionAddress address)
Sets theWebSubscriptionAddress
to be associated with this subscription
-
getContent
WebSubscriptionContent getContent() throws WebObjectsException
This API is only available with valid information for single content subscription- Returns:
- the
WebSubscriptionContent
associated with this subscription - Throws:
WebObjectsException
-
restContentAndPersonalization
void restContentAndPersonalization() throws WebObjectsException
Reset the contents and associated personalization to be empty This API is only available with valid information for multiple content subscription- Throws:
WebObjectsException
-
resetRdfMap
void resetRdfMap()
Rest rdf map for update workflow so that the rdf map gets cleaned up to populate updated information
-
getContents
java.util.List<WebSubscriptionContent> getContents() throws WebObjectsException
Get the content list of the subscription The usage of the API would actually needs WebIServerSubscriptionContentResultSetImpl in many cases- Returns:
- Throws:
WebObjectsException
-
getContentList
java.util.List<WebSubscriptionContent> getContentList() throws WebObjectsException
Get the content list of the subscription- Returns:
- Throws:
WebObjectsException
-
getContentPls
java.util.Map<java.lang.String,WebContentPersonalization> getContentPls()
Get the map contains the content personalization of all the contents This API is only available with valid information for multiple content subscription- Returns:
-
getContentPersonalizationByContentIndex
WebContentPersonalization getContentPersonalizationByContentIndex(int index) throws WebObjectsException
Get the content personalization by the content index This API is only available with valid information for multiple content subscription- Returns:
- the content personalization (@link WebContentPersonalization) if it is found in the map, otherwise it return null
- Throws:
WebObjectsException
-
getContent
WebSubscriptionContent getContent(int index) throws WebObjectsException
This API is only available with valid information for multiple content subscription- Returns:
- the
WebSubscriptionContent
associated with this subscription - Throws:
WebObjectsException
-
setContent
WebSubscriptionContent setContent(WebObjectInfo woi) throws WebObjectsException
sets the content for this subscription This API is only available with valid information for single content subscription- Parameters:
woi
-WebObjectInfo
object representing either a report or a document- Returns:
- the
WebSubscriptionContent
associated with this subscription - Throws:
WebObjectsException
- Thrown if the input parameter does not correspond to a valid report/document.
-
setContents
WebSubscriptionContent setContents(WebObjectInfo woi, int index) throws WebObjectsException
sets the contents for this multiple content subscription This API is only available with valid information for multiple content subscription- Parameters:
woi
-WebObjectInfo
object representing either a report or a documentindex
- the index of the content in the subscription- Returns:
- the
WebSubscriptionContent
associated with this subscription - Throws:
WebObjectsException
- Thrown if the input parameter does not correspond to a valid report/document.
-
isPersonalized
boolean isPersonalized() throws WebObjectsException
This indicates whether the content that we are creating a subscription for is prompted- Returns:
- boolean value indicating whether the content is personalized
- Throws:
WebObjectsException
-
setDeliveryMode
void setDeliveryMode(int deliveryMode)
Sets delivery mode.- Parameters:
deliveryMode
- one of the delivery modes specified inEnumWebSubscriptionDeliveryMode
Each enumerated value inEnumWebSubscriptionDeliveryMode
corresponds to a specificWebSubscriptionDeliveryModeProperties
sub-interface:EnumWebSubscriptionDeliveryMode.SUBSCRIPTION_DELIVERY_MODE_EMAIL
:WebSubscriptionDeliveryModeEmailProperties
EnumWebSubscriptionDeliveryMode.SUBSCRIPTION_DELIVERY_MODE_FILE
:WebSubscriptionDeliveryModeFileProperties
EnumWebSubscriptionDeliveryMode.SUBSCRIPTION_DELIVERY_MODE_PRINT
:WebSubscriptionDeliveryModePrintProperties
- Since:
- MicroStrategy Web 7.5.1
-
setLocation
void setLocation(WebSubscriptionLocation location)
Sets theWebSubscriptionLocation
to be associated with this subscription A location is an abstraction that encomposses either an address or a device and is useful while creating File or Print subscriptions. Note that either this or thesetAddress(WebSubscriptionAddress)
could be used- Since:
- MicroStrategy Web 7.5.1
- See Also:
setAddress(WebSubscriptionAddress)
-
getLocation
WebSubscriptionLocation getLocation()
Retrieves theWebSubscriptionLocation
associated with this subscription- Since:
- MicroStrategy Web 7.5.1
- See Also:
setLocation(WebSubscriptionLocation)
-
getNotification
WebSubscriptionNotification getNotification()
Retrieves theWebSubscriptionNotification
object that can edited to specify whether any notification mechanism should be specified while creating the subscription. Typically, you can create an email notification while creatin a file or print subscription- Since:
- MicroStrategy Web 8.0.0
-
getOwner
WebUserEntity getOwner() throws WebObjectsException
This call returns theWebUserEntity
who is the owner of the subscription. The owner of a subscription is the user who created the subscription- Returns:
WebUserEntity
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getRecipients
WebSubscriptionRecipientList getRecipients()
Returns theWebSubscriptionRecipientList
, which is a collection interface ofWebSubscriptionRecipient
objects who are subscribed to the current subscription.- Returns:
WebSubscriptionRecipientList
- Since:
- MicroStrategy Web 9.0.0
-
getSubscriptionType
int getSubscriptionType()
Returns the type of the subscription, fromEnumDSSXMLNCSSubscriptionType
.- Returns:
- int from
EnumDSSXMLNCSSubscriptionType
- Since:
- MicroStrategy Web 9.0.0
-
isAlertingSubscription
boolean isAlertingSubscription()
Returnstrue
if the subscription is used to define an alert This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.0.0
-
setAlertingSubscription
void setAlertingSubscription(boolean val) throws WebObjectsException
Sets the subscription to be an alerting subscription. If no content is set for alerting using This API is only available with valid information for single content subscriptionsetContentForAlert(WebObjectInfo)
, the current contentgetContent()
will be used.- Parameters:
val
-- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getContentForAlert
WebObjectInfo getContentForAlert()
Returns the report that has been configured to be delivered for the alert. While the condition of the alert is defined on theWebSubscriptionContent
, the report that is configured to be delivered could be a different one. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.0.0
-
setContentForAlert
void setContentForAlert(WebObjectInfo woi)
Sets the report that needs to be delivered when an alerting condition is met. This could be the same report on which the alerting condition is based or a different one. This API is only available with valid information for single content subscription- Parameters:
woi
-- Since:
- MicroStrategy Web 9.0.0
-
setOwner
void setOwner(WebUserEntity owner)
Sets the owner of the subscription. By default the owner of a subscription is the user whose session is used to create the subscription. However if you have the privilege to monitor and administer subscriptions, you can modify subscriptions created by other users or even create subscriptions for other users. Setting the owner as another user will essentially tie the subscription to this user.- Parameters:
owner
-- Since:
- MicroStrategy Web 9.0.0
-
setName
void setName(java.lang.String name)
Sets the name of the subscription.- Parameters:
name
-- Since:
- MicroStrategy Web 9.0.0
-
setContent
void setContent(WebResultSetInstance instance) throws WebObjectsException
Sets the content of this subscription based on an existing instance. The instance can either be aWebReportInstance
or aRWInstance
This API is only available with valid information for single content subscription- Parameters:
instance
-- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
setContentMCS
void setContentMCS(WebResultSetInstance instance, int index) throws WebObjectsException
Sets the content of this subscription based on an existing instance. The instance can either be aWebReportInstance
or aRWInstance
- Parameters:
instance
-- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
setIsMCS
void setIsMCS(boolean isMCS)
Set a multiple content subscription to be true, by default it is false - for single content subscription set _isMCS- Parameters:
isMCS
-
-
getIsMCS
boolean getIsMCS()
Get a multiple content subscription to be true, by default it is false - for single content subscription- Returns:
- _isMCS
-
getInstancePersonalization
WebInstancePersonalization getInstancePersonalization()
Get instance personalization from a multiple content subscription. This API is only available with valid information for multiple content subscription- Returns:
- an instance of WebInstancePersonalization. The members of the instance may not be initialized.
-
setInstancePersonalization
void setInstancePersonalization(WebInstancePersonalization iInstancePls)
Set the instance personalization for a multiple content subscription. This API is only available with valid information for multiple content subscription
-
getPromptAnswerXML
java.lang.String getPromptAnswerXML() throws WebObjectsException
- Throws:
WebObjectsException
-
getIncludePrompts
boolean getIncludePrompts()
-
setIncludePrompts
void setIncludePrompts(boolean value)
-
setBurstList
void setBurstList(java.util.ArrayList burstList)
-
getBurstList
java.util.ArrayList getBurstList()
-
isInvalidSchedule
boolean isInvalidSchedule()
-
getBurstAddressAttributeId
java.lang.String getBurstAddressAttributeId()
gets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
setBurstAddressAttributeId
void setBurstAddressAttributeId(java.lang.String burstAddressID)
sets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
setBurstDeviceId
void setBurstDeviceId(java.lang.String burstDeviceID)
gets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
getBurstDeviceId
java.lang.String getBurstDeviceId()
sets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
getBurstFormId
java.lang.String getBurstFormId()
gets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
setBurstFormId
void setBurstFormId(java.lang.String burstFormID)
sets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
getBurstLayoutKey
java.lang.String getBurstLayoutKey()
gets the layout key that contains the attribute. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
setBurstLayoutKey
void setBurstLayoutKey(java.lang.String burstLayoutKey)
sets the layout key that contains the attribute. This API is only available with valid information for single content subscription- Since:
- MicroStrategy Web 9.4
-
getEMMACubeOptions
WebSubscriptionEMMACubeOptions getEMMACubeOptions()
Returns the associateWebSubscriptionEMMACubeOptions
interface which represent the EMMA cube related options for this subscription This API is only available with valid information for single content subscription- Returns:
WebSubscriptionEMMACubeOptions
for this subscription
-
getOrCreateEMMACubeOptions
WebSubscriptionEMMACubeOptions getOrCreateEMMACubeOptions()
Returns the associateWebSubscriptionEMMACubeOptions
interface which represent the EMMA cube related options for this subscription, if it was not create yet this function will create and return it. This API is only available with valid information for single content subscription- Returns:
WebSubscriptionEMMACubeOptions
for this subscription
-
setReuseDataSetCache
void setReuseDataSetCache(boolean isReuseDataSetCache)
This API is only available with valid information for single content subscription- Parameters:
isReuseDataSetCache
-
-
isReuseDataSetCache
boolean isReuseDataSetCache()
This API is only available with valid information for single content subscription- Returns:
-
getRecipientSubscriptionIDForPersonalView
java.lang.String getRecipientSubscriptionIDForPersonalView()
Returns the subscription ID of recipient for personal view subscription. For other subscription, it will directly return its ID. This API is only available with valid information for single content subscription
-
addContentPls
void addContentPls(java.lang.String key, WebContentPersonalization lContentPls)
Set content personalization to the map MapcontentPls, key is content id defined by XMLTags.Att_CnID in the subscription for get subscriptions. This API is only available with valid information for multiple content subscription - Parameters:
key
-lContentPls
-
-
getContentPlsByKey
WebContentPersonalization getContentPlsByKey(java.lang.String key)
Get content personalization from the map MapcontentPls, key is content id defined by XMLTags.Att_CnID in the subscription for get subscriptions. This API is only available with valid information for multiple content subscription - Parameters:
key
-- Returns:
- an instance of WebContentPersonalization, return null if the key cannot be find in the map
-
-