public interface

WebSubscriptionsSource

implements WebFeatures
com.microstrategy.web.objects.WebSubscriptionsSource

Class Overview

The WebSubscriptionsSource interface allows the user to retrieve objects related to subscription creation/manipulation and it's dependencies.

Summary

Constants
int SORT_FIELD_ADDRESS_NAME sorts the collections by the display name of the address
int SORT_FIELD_ADDRESS_PHYSICAL_VALUE sorts the collections by the display name of the address
int SORT_FIELD_DEVICE_NAME sorts the collections by the display name of the _device
int SORT_FIELD_OWNER_NAME sorts the collections by the owner name
int SORT_FIELD_PERSONALIZATION sorts the collections by the whether or not they are personalized
int SORT_FIELD_RECIPIENT_NAME sorts the collections by the recipient name
int SORT_FIELD_SCHEDULE_NAME sorts the collections by the display name of the schedule
int SORT_FIELD_SUBSCRIPTION_NAME Sorts the collections by the subscription name
int SORT_FIELD_TARGET_NAME sorts the collections by the display name of the report/document
int SUBSCRIPTION_SETUP_STATUS_DISABLED
int SUBSCRIPTION_SETUP_STATUS_ENABLED
int SUBSCRIPTION_SETUP_STATUS_ENGINE_NOT_CONFIGURED
int SUBSCRIPTION_SETUP_STATUS_NOT_INSTALLED
int SUBSCRIPTION_SETUP_STATUS_PROJECT_NOT_CONFIGURED
Public Methods
abstract void addRecipientsToSubscription(WebSubscriptionRecipientList recipients, String subscriptionID)
Adds the specified recipients to the subscription with the specified ID.
abstract boolean checkNCSCSConfigured()
Utility method to check if Content Services is configured for Distribution Services in the metadata
abstract WebScheduledMaintenance createScheduledMaintenance(WebScheduleTrigger trigger, WebProject project, int commandID, ArrayList<ScheduledMaintenanceParameter> parm)
Create a new WebScheduledMaintenance object.
abstract SimpleList getAddresses(int contentType, int deliveryMode)
This method is deprecated. Please use getAddressesByDeliveryMode(int) instead
abstract SimpleList getAddresses()
This method is deprecated. Please use getAddressesByDeliveryMode(int) instead
abstract SimpleList getAddresses(int contentType)
This method is deprecated. Please use getAddressesByDeliveryMode(int) instead
abstract SimpleList getAddressesByDeliveryMode(int deliveryMode, WebUser user)
Retrieves the list of all addresses for the given user
abstract SimpleList getAddressesByDeliveryMode(int deliveryMode)
Retrieves list of WebSubscriptionAddress objects for the given delivery mode
abstract SimpleList getAvailableFormats(int contentType, int deliveryMode)
Retrieves list of WebSubscriptionContentFormat objects for the given delivery mode and contentType
abstract SimpleList getAvailableFormats(WebResultSetInstance ri, int contentType, int deliveryMode)
This method is deprecated. Please use getAvailableFormats() instead.
abstract int getBlockBegin()
Returns the current starting count set for the incremental fetch of the subscriptions.
abstract int getBlockCount()
Returns the current block size set for the incremental fetch of the subscriptions.
abstract WebSubscription getCopy(WebSubscription ws)
Used to make copy of the WebSubscription object that is passed in
abstract WebSubscriptionDevice getDevice(String deviceID)
Retrieves a WebSubscriptionDevice using the id.
abstract SimpleList getDevices()
Returns the list of available devices
abstract SimpleList getDevices(int contentType, int deliveryMode)
Retrieves list of WebSubscriptionDevice objects for the given delivery mode and contentType
abstract SimpleList getDevices(int contentType)
Returns the list of available devices for a specific content type
abstract SimpleList getDevicesByDeliveryMode(int deliveryMode)
Retrieves list of WebSubscriptionDevice objects for the given delivery mode and contentType
abstract int getFlags()
Returns the current setting of the flags which will determine what data will be obtained when retrieving subscriptions from the Intelligence Server.This will affect all getSubscriptions calls on this interface.
abstract WebSubscriptionLocation getLocation(String locationKey, int contentType, int deliveryMode)
Retrieves a WebSubscriptionLocation object using the key provided.
abstract SimpleList getLocations(int contentType, int deliveryMode)
This method is deprecated. Please use getLocationsByDeliveryMode(int) instead
abstract SimpleList getLocations(int contentType)
This method is deprecated. Please use getLocationsByDeliveryMode(int) instead
abstract SimpleList getLocationsByDeliveryMode(int deliveryMode)
Retrieves a SimpleList of WebSubscriptionLocation objects corresponding to the given delivery mode
abstract WebSubscriptionComponent getNewObject(int type)
Returns a reference to an new object of the specified type.
abstract WebSubscriptionRecipientList getNewRecipientList(int deliveryMode)
Returns an empty recipient list to hold the specified type of recipients
abstract WebSubscriptionsFilter getNewSubscriptionsFilter()
Returns a clean filter to be modified to manipulate which subscriptions are returned by getSubscriptions calls on this and other objects
abstract SimpleList getNotificationAddresses(int subscriptionDeliveryMode, int notificationDeliveryMode)
Retrieves a list of notification addresses that are available.
abstract SimpleList getNotificationDevices(int subscriptionDeliveryMode, int notificationDeliveryMode)
Retrieves a list of notification devices that are available.
abstract WebSubscriptionComponent getObject(String id, int type)
Returns a reference to an object that already exists in the metadata.
abstract WebSubscriptionComponent getObject(String id, int type, boolean populate)
Returns a reference to an object that already exists in the metadata.
abstract WebProjectSettings getProjectSettings(int type, int moduleID)
Returns the WebProjectSettings object for a specific module.
abstract WebScheduledMaintenances getScheduledMaintenances()
Retrieve WebScheduledMaintenances object from i-server.
abstract int getSortField()
abstract int getSubscriptionCount(WebObjectInfo woi, int deliveryMode)
Returns the count of the list of available subscriptions corresponding to the specified object and delivery mode
abstract int getSubscriptionSetupStatus()
This is a convenience method for determining if the subscription functionality is set up correctly to work.
abstract SimpleList getSubscriptionTriggers(String id, int type, String projId)
Triggers are first class objects in the MicroStrategy MD.
abstract SimpleList getSubscriptions()
Returns the list of available subscriptions
abstract SimpleList getSubscriptions(WebObjectInfo woi, int deliveryMode)
Returns the list of available subscriptions corresponding to the specified object and delivery mode
abstract SimpleList getSubscriptions(WebObjectInfo woi, WebSubscriptionsFilter filter)
Returns a SimpleList collection of WebSubscription objects to which this particular object is the subscription content, from a specified begin block, up to a specified block count.
abstract SimpleList getSubscriptions(WebObjectInfo woi)
Returns the list of available subscriptions for the given object (which is a report or document)
abstract SimpleList getSubscriptionsByDeliveryMode(int deliveryMode)
Retrieves a SimpleList of subscriptions corresponding to the given delivery mode
abstract SimpleList getSubscriptionsByDeliveryMode(int deliveryMode, String projectDSSID)
Returns the list of available subscriptions corresponding to the specified object and delivery mode and for a particular project.
abstract WebSubscriptionTrigger getTriggerByTimePattern(int monthValue, int monthRecurrence, int weekValue, int weekRecurrence, int dayValue, int dayRecurrence, int dayOfWeekValue, int dayOfWeekRecurrence, int hourValue, int hourRecurrence)
This method gets the hidden time based time trigger in MD by its definition
abstract WebSubscriptionTrigger getTriggerByTimePatternDaily(int hour)
This method get the hidden Daily triggered trigger in MD by hour.
abstract WebSubscriptionTrigger getTriggerByTimePatternMonthly(int day, int hour)
This methods gets the hidden Monthly triggered trigger in MD by day and hour.
abstract WebSubscriptionTrigger getTriggerByTimePatternWeekday(int hour)
This method gets the hidden Weekday triggered trigger in MD by hour.
abstract WebSubscriptionTrigger getTriggerByTimePatternWeekly(int week, int hour)
This method gets the hidden Weekly triggered trigger in MD by week and hour.
abstract SimpleList getTriggers(int contentType)
This method is deprecated. Please use getTriggers() instead
abstract WebFolder getTriggers(String id, int contentType, String pgd)
Triggers are first class objects in the MicroStrategy MD.
abstract SimpleList getTriggers(int contentType, int deliveryMode)
This method is deprecated. Please use getTriggers() instead.
abstract SimpleList getTriggers(String id, int contentType, int deliveryMode, String projectId)
Retrieves list of WebSubscriptionTrigger objects for the given delivery mode and contentType
abstract WebFolder getTriggers()
Triggers are first class objects in the MicroStrategy MD.
abstract boolean hasAnySubscription()
Indicate if the user logged in has at least one subscription.
abstract void init(String resourceDir)
This call should be made before any subscription functionality is used.
abstract boolean isIServerNCSSource()
This method indicates whether the current WebSubscriptionsSource connects to the MicroStrategy Intelligence server for all Narrowcast related information (TRUE) or the Narrowcast Server for the same (false)
abstract boolean isSortAscending()
abstract boolean isUserAllowedToSubscribe(String objectID, int objectType, String userID, String projectID)
whether allow user to subscribe report/document
abstract WebSubscriptionContentFormat restoreFormatFromState(String state)
Creates the content format object given an input state
abstract WebSubscriptionComponent restoreObject(String state, int type)
Returns a reference to an object that already exists in the metadata.
abstract WebSubscription restoreSubscriptionFromState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
Creates a new WebSubscription object from the given state
abstract void setBlockBegin(int blockBegin)
Sets the starting count for all the getSubscriptions() methods exposed in this interface.
abstract void setBlockCount(int blockCount)
Sets the block size for the incremental fetch of the getSubscriptions() method.
abstract void setFlags(int flags)
Sets the current setting of the flags which will determine what data will be obtained when retrieving subscriptions from the Intelligence Server.
abstract void setSortAscending(boolean order)
Sets the sort order
abstract void setSortField(int sortField)
Sets the field based on which the returned collections would be sorted
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebFeatures

Constants

public static final int SORT_FIELD_ADDRESS_NAME

sorts the collections by the display name of the address

Constant Value: 0 (0x00000000)

public static final int SORT_FIELD_ADDRESS_PHYSICAL_VALUE

sorts the collections by the display name of the address

Constant Value: 2 (0x00000002)

public static final int SORT_FIELD_DEVICE_NAME

sorts the collections by the display name of the _device

Constant Value: 8 (0x00000008)

public static final int SORT_FIELD_OWNER_NAME

sorts the collections by the owner name

Constant Value: 64 (0x00000040)

public static final int SORT_FIELD_PERSONALIZATION

sorts the collections by the whether or not they are personalized

Constant Value: 32 (0x00000020)

public static final int SORT_FIELD_RECIPIENT_NAME

sorts the collections by the recipient name

Constant Value: 128 (0x00000080)

public static final int SORT_FIELD_SCHEDULE_NAME

sorts the collections by the display name of the schedule

Constant Value: 4 (0x00000004)

public static final int SORT_FIELD_SUBSCRIPTION_NAME

Sorts the collections by the subscription name

Constant Value: 256 (0x00000100)

public static final int SORT_FIELD_TARGET_NAME

sorts the collections by the display name of the report/document

Constant Value: 16 (0x00000010)

public static final int SUBSCRIPTION_SETUP_STATUS_DISABLED

Constant Value: 2 (0x00000002)

public static final int SUBSCRIPTION_SETUP_STATUS_ENABLED

Constant Value: 1 (0x00000001)

public static final int SUBSCRIPTION_SETUP_STATUS_ENGINE_NOT_CONFIGURED

Constant Value: 4 (0x00000004)

public static final int SUBSCRIPTION_SETUP_STATUS_NOT_INSTALLED

Constant Value: 3 (0x00000003)

public static final int SUBSCRIPTION_SETUP_STATUS_PROJECT_NOT_CONFIGURED

Constant Value: 5 (0x00000005)

Public Methods

public abstract void addRecipientsToSubscription (WebSubscriptionRecipientList recipients, String subscriptionID)

Adds the specified recipients to the subscription with the specified ID. The specified WebSubscriptionRecipientListImpl should have the same delivery mode as the subscription with the specified ID

Parameters
recipients WebSubscriptionRecipientList containing the recipients to be added
subscriptionID String containing the subscription to add the recipients to
Throws
WebObjectsException

public abstract boolean checkNCSCSConfigured ()

Utility method to check if Content Services is configured for Distribution Services in the metadata

Throws
WebObjectsException
WebObjectsException

public abstract WebScheduledMaintenance createScheduledMaintenance (WebScheduleTrigger trigger, WebProject project, int commandID, ArrayList<ScheduledMaintenanceParameter> parm)

Create a new WebScheduledMaintenance object.

Returns
Throws
if there is an error in populating the details from IServer.
WebObjectsException

public abstract SimpleList getAddresses (int contentType, int deliveryMode)

This method is deprecated.
Please use getAddressesByDeliveryMode(int) instead

Retrieves a SimpleList of WebSubscriptionAddress objects

Parameters
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which addresses should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getAddresses ()

This method is deprecated.
Please use getAddressesByDeliveryMode(int) instead

Returns
  • SimpleList of the all user addresses. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of addresses from the metadata

public abstract SimpleList getAddresses (int contentType)

This method is deprecated.
Please use getAddressesByDeliveryMode(int) instead

Parameters
contentType as defined in EnumWebSubscriptionContentTypes
Returns
  • SimpleList of the user's addresses that can be used for a specific content type. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of addresses from the metadata

public abstract SimpleList getAddressesByDeliveryMode (int deliveryMode, WebUser user)

Retrieves the list of all addresses for the given user

Returns
  • the list of all addresses for the given user
Throws
WebObjectsException

public abstract SimpleList getAddressesByDeliveryMode (int deliveryMode)

Retrieves list of WebSubscriptionAddress objects for the given delivery mode

Parameters
deliveryMode indicates the delivery mode for which addresses should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getAvailableFormats (int contentType, int deliveryMode)

Retrieves list of WebSubscriptionContentFormat objects for the given delivery mode and contentType

Parameters
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which formats should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode Please note that this method does not filter out formats which are not supported by a report or document. For example, the flash format is supported only if the document or report is enabled for visualizations. Please use getAvailableFormats() to get a filtered list depending on the report or document
Throws
WebObjectsException

public abstract SimpleList getAvailableFormats (WebResultSetInstance ri, int contentType, int deliveryMode)

This method is deprecated.
Please use getAvailableFormats() instead.

Retrieves list of WebSubscriptionContentFormat objects for the given delivery mode and contentType

Parameters
ri Some formats rely on properties configured on the report or document.
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which formats should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract int getBlockBegin ()

Returns the current starting count set for the incremental fetch of the subscriptions. Please see setBlockBegin(int) for more details.

public abstract int getBlockCount ()

Returns the current block size set for the incremental fetch of the subscriptions. Please see setBlockCount(int) for more details.

public abstract WebSubscription getCopy (WebSubscription ws)

Used to make copy of the WebSubscription object that is passed in

Parameters
ws the subscription for which a copy needs to be made
Returns
Throws
WebObjectsException

public abstract WebSubscriptionDevice getDevice (String deviceID)

Retrieves a WebSubscriptionDevice using the id.

Parameters
deviceID ID of the device
Throws
WebObjectsException

public abstract SimpleList getDevices ()

Returns the list of available devices

Returns
  • SimpleList of the all the devices that the user can create addresses for. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of devices from the metadata

public abstract SimpleList getDevices (int contentType, int deliveryMode)

Retrieves list of WebSubscriptionDevice objects for the given delivery mode and contentType

Parameters
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which devices should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getDevices (int contentType)

Returns the list of available devices for a specific content type

Parameters
contentType as defined in EnumWebSubscriptionContentTypes
Returns
  • SimpleList of the all the devices that the user can create addresses for. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of devices from the metadata

public abstract SimpleList getDevicesByDeliveryMode (int deliveryMode)

Retrieves list of WebSubscriptionDevice objects for the given delivery mode and contentType

Parameters
deliveryMode indicates the delivery mode for which devices should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract int getFlags ()

Returns the current setting of the flags which will determine what data will be obtained when retrieving subscriptions from the Intelligence Server.This will affect all getSubscriptions calls on this interface. This value will come from EnumDSSXMLNCSInstanceSourceField.

Returns
See Also

public abstract WebSubscriptionLocation getLocation (String locationKey, int contentType, int deliveryMode)

Retrieves a WebSubscriptionLocation object using the key provided. Typically this method is useful while persisting and restoring the state of a specific location

Parameters
locationKey the key of the location object that needs to be retrieved. The key can be obtained using getStringKey() which is accessible from the location object
Throws
WebObjectsException

public abstract SimpleList getLocations (int contentType, int deliveryMode)

This method is deprecated.
Please use getLocationsByDeliveryMode(int) instead

Returns available locations for SUBSCRIPTION_DELIVERY_MODE_FILE and SUBSCRIPTION_DELIVERY_MODE_PRINT.

Parameters
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which locations should be retrieved returns subscriptions for one particular user.If you want to retrieve for all users then use the overloaded method which takes in the project ID as well Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getLocations (int contentType)

This method is deprecated.
Please use getLocationsByDeliveryMode(int) instead

Returns the list of locations for a given content type

Parameters
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
Throws
WebObjectsException

public abstract SimpleList getLocationsByDeliveryMode (int deliveryMode)

Retrieves a SimpleList of WebSubscriptionLocation objects corresponding to the given delivery mode

Parameters
deliveryMode indicates the delivery mode for which locations should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract WebSubscriptionComponent getNewObject (int type)

Returns a reference to an new object of the specified type.

Parameters
type integer type of the component as defined in EnumWebSubscriptionObjectTypes
Returns
Throws
WebObjectsException Thrown if the type specified is not supported

public abstract WebSubscriptionRecipientList getNewRecipientList (int deliveryMode)

Returns an empty recipient list to hold the specified type of recipients

Parameters
deliveryMode int from EnumDSSXMLSubscriptionDeliveryType to discern what type of recipients this list will hold. Only supports single delivery type
Returns
Throws
WebObjectsException

public abstract WebSubscriptionsFilter getNewSubscriptionsFilter ()

Returns a clean filter to be modified to manipulate which subscriptions are returned by getSubscriptions calls on this and other objects

Returns

public abstract SimpleList getNotificationAddresses (int subscriptionDeliveryMode, int notificationDeliveryMode)

Retrieves a list of notification addresses that are available. The parameters indicate the subscription and the notification delivery mode. For instance, you could create a file subscription (subscription delivery mode SUBSCRIPTION_DELIVERY_MODE_FILE) and have the notification sent to your email (notification delivery mode SUBSCRIPTION_DELIVERY_MODE_EMAIL)

Parameters
subscriptionDeliveryMode indicates the delivery mode for which a subscription is intended to be created Possible values are defined in EnumWebSubscriptionDeliveryMode
notificationDeliveryMode indicates the delivery mode in which the notification will be sent Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getNotificationDevices (int subscriptionDeliveryMode, int notificationDeliveryMode)

Retrieves a list of notification devices that are available. The parameters indicate the subscription and the notification delivery mode. For instance, you could create a file subscription (subscription delivery mode SUBSCRIPTION_DELIVERY_MODE_FILE) and have the notification sent to your email (notification delivery mode SUBSCRIPTION_DELIVERY_MODE_EMAIL)

Parameters
subscriptionDeliveryMode indicates the delivery mode for which a subscription is intended to be created Possible values are defined in EnumWebSubscriptionDeliveryMode
notificationDeliveryMode indicates the delivery mode in which the notification will be sent Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract WebSubscriptionComponent getObject (String id, int type)

Returns a reference to an object that already exists in the metadata.

Parameters
id String identifier of the component
type integer type of the component as defined in EnumWebSubscriptionObjectTypes
Returns
Throws
WebObjectsException Thrown if the object with the given id and type does not exist in the metadata

public abstract WebSubscriptionComponent getObject (String id, int type, boolean populate)

Returns a reference to an object that already exists in the metadata.

Parameters
id String identifier of the component
type integer type of the component as defined in EnumWebSubscriptionObjectTypes
populate boolean indicating whether or not the object reference retrieved should be populated with all the properties from the metadata
Returns
Throws
WebObjectsException Thrown if the object with the given id and type does not exist in the metadata

public abstract WebProjectSettings getProjectSettings (int type, int moduleID)

Returns the WebProjectSettings object for a specific module. Currently this can be used to get the project settings for notifications for various delivery modes.

Parameters
type from EnumDSSXMLProjectConfigurationSettingType
moduleID from EnumDSSXMLNotificationModuleID
Throws
WebObjectsException
WebObjectsException

public abstract WebScheduledMaintenances getScheduledMaintenances ()

Retrieve WebScheduledMaintenances object from i-server.

Returns
Throws
if there is an error in populating the details from IServer.
WebObjectsException

public abstract int getSortField ()

Returns
  • the integer identifier for the field which the collection would be sorted on.

public abstract int getSubscriptionCount (WebObjectInfo woi, int deliveryMode)

Returns the count of the list of available subscriptions corresponding to the specified object and delivery mode

Parameters
woi the object for which subscriptions are to be retrieved. The type of this object is one of
deliveryMode indicates the delivery mode for which subscriptions should be retrieved Possible values are defined in EnumDSSXMLSubscriptionDeliveryType
Throws
WebObjectsException
WebObjectsException

public abstract int getSubscriptionSetupStatus ()

This is a convenience method for determining if the subscription functionality is set up correctly to work.

Returns

public abstract SimpleList getSubscriptionTriggers (String id, int type, String projId)

Triggers are first class objects in the MicroStrategy MD. This method gets the current triggers within the project.

Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract SimpleList getSubscriptions ()

Returns the list of available subscriptions

Returns
  • SimpleList of the user's subscriptions. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of subscriptions from the metadata

public abstract SimpleList getSubscriptions (WebObjectInfo woi, int deliveryMode)

Returns the list of available subscriptions corresponding to the specified object and delivery mode

Parameters
woi the object for which subscriptions are to be retrieved. The type of this object is one of
deliveryMode indicates the delivery mode for which subscriptions should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getSubscriptions (WebObjectInfo woi, WebSubscriptionsFilter filter)

Returns a SimpleList collection of WebSubscription objects to which this particular object is the subscription content, from a specified begin block, up to a specified block count. These results will be filtered by the passed in WebSubscriptionsFilter

Parameters
woi WebObjectInfo object of either DssXmlTypeReportDefinition or DssXmlTypeDocumentDefinition
filter WebSubscriptionsFilter to restrict the results of this call. A blank filter can be retrieved from getNewSubscriptionsFilter()
Returns
Throws
WebObjectsException

public abstract SimpleList getSubscriptions (WebObjectInfo woi)

Returns the list of available subscriptions for the given object (which is a report or document)

Parameters
woi WebObjectInfo representing report/document for which subscriptions should be retrieved
Returns
  • SimpleList of the user's subscriptions. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of subscriptions from the metadata

public abstract SimpleList getSubscriptionsByDeliveryMode (int deliveryMode)

Retrieves a SimpleList of subscriptions corresponding to the given delivery mode

Parameters
deliveryMode indicates the delivery mode for which subscriptions should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getSubscriptionsByDeliveryMode (int deliveryMode, String projectDSSID)

Returns the list of available subscriptions corresponding to the specified object and delivery mode and for a particular project. Using this method with projectID will return all the subscriptions of this delivery mode for all users.This will be slower as compared to using it without projectID which will return all subscriptions of the delivery mode but only of the user using it.

Parameters
deliveryMode indicates the delivery mode for which subscriptions should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract WebSubscriptionTrigger getTriggerByTimePattern (int monthValue, int monthRecurrence, int weekValue, int weekRecurrence, int dayValue, int dayRecurrence, int dayOfWeekValue, int dayOfWeekRecurrence, int hourValue, int hourRecurrence)

This method gets the hidden time based time trigger in MD by its definition

Parameters
monthValue Month value of trigger definition
monthRecurrence Month recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
weekValue Week value of trigger definition
weekRecurrence Week recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
dayValue Day value of trigger definition
dayRecurrence Day recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
dayOfWeekValue Day Of Week value of trigger definition
dayOfWeekRecurrence Day Of Week recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
hourValue Hour value of trigger definition
hourRecurrence Hour recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
Returns
Throws
WebObjectsException

public abstract WebSubscriptionTrigger getTriggerByTimePatternDaily (int hour)

This method get the hidden Daily triggered trigger in MD by hour.

Parameters
hour Hour value in one Day, from 0 to 23.
Returns
Throws
WebObjectsException

public abstract WebSubscriptionTrigger getTriggerByTimePatternMonthly (int day, int hour)

This methods gets the hidden Monthly triggered trigger in MD by day and hour.

Parameters
day Day value in one month. Currently only support Start of Month and Middle of Month, eg. 1 or 15
hour Hour value in one Day, from 0 to 23.
Returns
Throws
WebObjectsException

public abstract WebSubscriptionTrigger getTriggerByTimePatternWeekday (int hour)

This method gets the hidden Weekday triggered trigger in MD by hour.

Parameters
hour Hour value in one Day, from 0 to 23.
Returns
Throws
WebObjectsException

public abstract WebSubscriptionTrigger getTriggerByTimePatternWeekly (int week, int hour)

This method gets the hidden Weekly triggered trigger in MD by week and hour.

Parameters
week Week value, value comes from EnumDSSXMLDayOfWeekBitEncoded
hour Hour value in one Day, from 0 to 23.
Returns
Throws
WebObjectsException

public abstract SimpleList getTriggers (int contentType)

This method is deprecated.
Please use getTriggers() instead

Returns the list of available triggers for a specific content type

Parameters
contentType as defined in EnumWebSubscriptionContentTypes
Returns
  • SimpleList of the all the triggers that the user can use for the specific contentType. This list is read-only.
Throws
WebObjectsException Thrown if there is an error reading the list of devices from the metadata

public abstract WebFolder getTriggers (String id, int contentType, String pgd)

Triggers are first class objects in the MicroStrategy MD. This method gets the current triggers within the project.

Parameters
id indicates the id of content.
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
pgd project Id.
Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract SimpleList getTriggers (int contentType, int deliveryMode)

This method is deprecated.
Please use getTriggers() instead.

Retrieves list of WebSubscriptionTrigger objects for the given delivery mode and contentType

Parameters
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which triggers should be retrieved Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract SimpleList getTriggers (String id, int contentType, int deliveryMode, String projectId)

Retrieves list of WebSubscriptionTrigger objects for the given delivery mode and contentType

Parameters
id indicates the id of content.
contentType Indicates the type of content. Possible values are defined in EnumWebSubscriptionContentTypes
deliveryMode indicates the delivery mode for which triggers should be retrieved
projectId indicated the id of project. Possible values are defined in EnumWebSubscriptionDeliveryMode
Throws
WebObjectsException

public abstract WebFolder getTriggers ()

Triggers are first class objects in the MicroStrategy MD. This method gets the current triggers Folder within the project.Triggers List can be retrieved from that.GetSubscriptionTriggers can be used to retrieve the List

Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract boolean hasAnySubscription ()

Indicate if the user logged in has at least one subscription. Currently, it's only used for showing the 'My Subscriptions' shortcut.

public abstract void init (String resourceDir)

This call should be made before any subscription functionality is used.

Parameters
resourceDir directory containing the merlin.ser file

public abstract boolean isIServerNCSSource ()

This method indicates whether the current WebSubscriptionsSource connects to the MicroStrategy Intelligence server for all Narrowcast related information (TRUE) or the Narrowcast Server for the same (false)

public abstract boolean isSortAscending ()

Returns
  • boolean indicating whether the sorting is going to be in ascending order

public abstract boolean isUserAllowedToSubscribe (String objectID, int objectType, String userID, String projectID)

whether allow user to subscribe report/document

Parameters
objectID report/document ID
objectType report/document
userID the user ID to subscribe
projectID the project ID
Returns
  • whether allow user to subscribe report/document
Throws
WebObjectsException

public abstract WebSubscriptionContentFormat restoreFormatFromState (String state)

Creates the content format object given an input state

Parameters
state the state of the format object
Returns
  • The WebSubscriptionContentFormat object restored from the state
Throws
WebObjectsException

public abstract WebSubscriptionComponent restoreObject (String state, int type)

Returns a reference to an object that already exists in the metadata. Note that this is just a convenience method. The effect of calling this should be the same as calling getObject followed by setXML.

Parameters
state String xml representing the state of a WebSubscriptionComponent
type integer type of the component as defined in EnumWebSubscriptionObjectTypes
Returns
Throws
WebObjectsException Thrown if there is an error reading the state string

public abstract WebSubscription restoreSubscriptionFromState (SAXSupport parser, String uri, String localName, String qName, Attributes attrs)

Creates a new WebSubscription object from the given state

Returns
Throws
WebObjectsException if the subscription could not be restored using the state.

public abstract void setBlockBegin (int blockBegin)

Sets the starting count for all the getSubscriptions() methods exposed in this interface. This will facilitate incremental fetching of the subscriptions. Please note that this does not apply to methods like getLocations(int), getAddresses() etc.

public abstract void setBlockCount (int blockCount)

Sets the block size for the incremental fetch of the getSubscriptions() method. Similar to setBlockBegin(int) this block count only applies to the fetching of subscriptions and not addresses, locations, devices or triggers.

public abstract void setFlags (int flags)

Sets the current setting of the flags which will determine what data will be obtained when retrieving subscriptions from the Intelligence Server. This will affect all getSubscriptions calls on this interface. This value should come from EnumDSSXMLNCSInstanceSourceField.

Parameters
flags int from EnumDSSXMLNCSInstanceSourceField
See Also

public abstract void setSortAscending (boolean order)

Sets the sort order

public abstract void setSortField (int sortField)

Sets the field based on which the returned collections would be sorted

Parameters
sortField indicates the field selected from the enumeration defined in this interface