Package com.microstrategy.web.objects
Interface WebIServerSubscriptionTrigger
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,StringKey
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
,WebSubscriptionComponent
,WebSubscriptionTrigger
public interface WebIServerSubscriptionTrigger extends WebSubscriptionTrigger, WebObjectInfo
- Since:
- MicroStrategy Web 9.0.0
-
-
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 Modifier and Type Method Description java.time.ZonedDateTime
getNextDeliveryZonedDateTime()
Returns the next delivery of Time Based Trigger/Schedule in ZonedDateTime format.SimpleList
getSubscriptions(int deliveryMode)
Returns aSimpleList
collection ofWebSubscription
objects which use this trigger/schedule for a specified deliveryMode.SimpleList
getSubscriptions(int deliveryMode, int blockBegin, int blockCount)
Returns aSimpleList
collection ofWebSubscription
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.SimpleList
getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)
Returns aSimpleList
collection ofWebSubscription
objects which use this particular trigger, from a specified begin block, up to a specified block count.int
getTriggerType()
Returns if the trigger is event based(EnumDSSXMLScheduleTriggerType.DssXmlTriggerEvent) or time based(EnumDSSXMLScheduleTriggerType.DssXmlTriggerTimePointSeries).-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
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.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionComponent
getDescription, getID, getName, getSessionInfo, getType, isPopulated, populate
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionTrigger
isSendNow
-
-
-
-
Method Detail
-
getSubscriptions
SimpleList getSubscriptions(int deliveryMode) throws WebObjectsException
Returns aSimpleList
collection ofWebSubscription
objects which use this trigger/schedule for a specified deliveryMode.- Parameters:
deliveryMode
- , fromEnumDSSXMLSubscriptionDeliveryType
- Throws:
WebObjectsException
-
getSubscriptions
SimpleList getSubscriptions(int deliveryMode, int blockBegin, int blockCount) throws WebObjectsException
Returns aSimpleList
collection ofWebSubscription
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:
deliveryMode
- , fromEnumDSSXMLSubscriptionDeliveryType
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
-
getSubscriptions
SimpleList getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount) throws WebObjectsException
Returns aSimpleList
collection ofWebSubscription
objects which use this particular trigger, from a specified begin block, up to a specified block count. The results are filtered by the specified filter- Parameters:
filter
-WebSubscriptionsFilter
used to filter results. A blank filter can be retrieved fromWebSubscriptionsSource.getNewSubscriptionsFilter()
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 filteredWebSubscription
objects- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.1
-
getNextDeliveryZonedDateTime
java.time.ZonedDateTime getNextDeliveryZonedDateTime()
Returns the next delivery of Time Based Trigger/Schedule in ZonedDateTime format. The ZonedDateTime contains the date, time and server TimeZone associated with Trigger/Schedule- Returns:
- ZonedDateTime
- Since:
- MicroStrategy Web 11.3
-
getTriggerType
int getTriggerType()
Returns if the trigger is event based(EnumDSSXMLScheduleTriggerType.DssXmlTriggerEvent) or time based(EnumDSSXMLScheduleTriggerType.DssXmlTriggerTimePointSeries).- Returns:
- int
- Since:
- MicroStrategy Web 11.3
-
-