public interface

SubscriptionFolderBean

implements WebBean
com.microstrategy.web.beans.SubscriptionFolderBean

Summary

Constants
int SUBSCRIPTION_FOLDER_CONTENT_TYPE_ADDRESS Content type for an address.
int SUBSCRIPTION_FOLDER_CONTENT_TYPE_DEVICE Content type for a device.
int SUBSCRIPTION_FOLDER_CONTENT_TYPE_MOBILE_SCHEDULE Content type for mobile subscriptions
int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE This constant is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION instead.
int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE_TRIGGER Content type for a schedule trigger.
int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION Content type for a subscription.
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void delete()
Deletes the objects that are specified by the filter using the getFilter method on this bean.
abstract int getBlockBegin()
Returns the value of blockBegin set on this object.
abstract int getBlockCount()
Returns the value of blockCount set on this object.
abstract SimpleList getComponents()
Returns the list of objects specified by the type.
abstract SimpleList getComponentsByDeliveryMode(int mode)
Returns a list of objects from the folder that have one of the specified delivery modes.
abstract int getContentType()
the possible types here are triggers, subscriptions, devices (constants defined in this interface)
abstract int getDeliveryMode()
Retrieves only components with specified delivery mode from EnumWebSubscriptionDeliveryMode.
abstract SimpleList getFilter()
Editable list of Identifiers of objects that is used in the case of delete In the case of subscriptions and addresses, the identifiers are just the IDs In the case of schedules, the identifiers are the saved state of the individual schedules The filter is cleared once delete is called on this bean
abstract int getSortField(int mode)
Retrieves the sort field for the specified delivery mode (if set)
abstract int getSortField()
Retrieves the sort field
abstract ObjectBean getTarget()
retrieves the target that was set using setTarget
abstract boolean isSortAscending()
returns whether the sort is ascending
abstract boolean isSortAscending(int mode)
returns whether the sort for the specified delivery mode is ascending
abstract void setBlockBegin(int blockBegin)
Sets the value of blockBegin on this object.
abstract void setBlockCount(int blockCount)
Sets the value of blockCount on this object.
abstract void setContentType(int type)
the possible types here are triggers, subscriptions, devices
abstract void setDeliveryMode(int deliveryMode)
Sets retrieval for components with specified delivery mode (EnumWebSubscriptionDeliveryMode).
abstract void setSortAscending(boolean asc)
sets the sort order to be ascending or descending
abstract void setSortField(int sortField)
sets the sort field
abstract void setSortForDeliveryMode(int mode, int field, boolean ascending)
sets the sort field and order for the specified delivery mode
abstract void setTarget(String ObjectID, int objectType)
sets the object for which components should be retrieved.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_ADDRESS

Content type for an address.

Constant Value: 16 (0x00000010)

public static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_DEVICE

Content type for a device.

Constant Value: 8 (0x00000008)

public static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_MOBILE_SCHEDULE

Content type for mobile subscriptions

Constant Value: 32 (0x00000020)

public static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE

This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION instead.

Content type for a schedule.

Constant Value: 1 (0x00000001)

public static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE_TRIGGER

Content type for a schedule trigger.

Constant Value: 2 (0x00000002)

public static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION

Content type for a subscription.

Constant Value: 4 (0x00000004)

Public Methods

public abstract void delete ()

Deletes the objects that are specified by the filter using the getFilter method on this bean.

Throws
WebBeanException

public abstract int getBlockBegin ()

Returns the value of blockBegin set on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list..

Returns
  • the value of blockBegin on this object.

public abstract int getBlockCount ()

Returns the value of blockCount set on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list

Returns
  • the value of blockCount on this object.

public abstract SimpleList getComponents ()

Returns the list of objects specified by the type. The returned objects need to be cast to the appropriate type

Returns
  • the list of objects specified by the type.
Throws
WebBeanException

public abstract SimpleList getComponentsByDeliveryMode (int mode)

Returns a list of objects from the folder that have one of the specified delivery modes. Objects without delivery types (e.g. triggers and schedules) in the folder will be returned. The returned objects need to be cast to the appropriate type. Does not repopulate unless no initial population has occurred or folder contents have become stale

Parameters
mode int specifying a set of bitwise ORed modes from EnumDSSXMLSubscriptionDeliveryType
Returns
  • SimpleList of objects
Throws
WebBeanException

public abstract int getContentType ()

the possible types here are triggers, subscriptions, devices (constants defined in this interface)

Returns
  • the type of contents this bean holds

public abstract int getDeliveryMode ()

Retrieves only components with specified delivery mode from EnumWebSubscriptionDeliveryMode. If unspecified, or set to -1, no delivery mode filtering is performed.

Returns
  • the delivery mode.

public abstract SimpleList getFilter ()

Editable list of Identifiers of objects that is used in the case of delete In the case of subscriptions and addresses, the identifiers are just the IDs In the case of schedules, the identifiers are the saved state of the individual schedules The filter is cleared once delete is called on this bean

Returns
  • editable SimpleList of identifiers

public abstract int getSortField (int mode)

Retrieves the sort field for the specified delivery mode (if set)

Parameters
mode int specifying the delivery mode (from EnumDSSXMLSubscriptionDeliveryType)
Returns
  • int sort field. -1 if not previously set

public abstract int getSortField ()

Retrieves the sort field

Returns
  • the sort field

public abstract ObjectBean getTarget ()

retrieves the target that was set using setTarget

Returns
  • ObjectBean of the target for which components are to be retrieved. Returns null if no target was set
Throws
WebBeanException

public abstract boolean isSortAscending ()

returns whether the sort is ascending

Returns
  • whether the sort is ascending

public abstract boolean isSortAscending (int mode)

returns whether the sort for the specified delivery mode is ascending

Parameters
mode int specifying the delivery mode (from EnumDSSXMLSubscriptionDeliveryType)
Returns
  • whether the sort is ascending

public abstract void setBlockBegin (int blockBegin)

Sets the value of blockBegin on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list

Parameters
blockBegin The blockBegin to be set for this object.

public abstract void setBlockCount (int blockCount)

Sets the value of blockCount on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list

Parameters
blockCount The blockCount to be set for this object.

public abstract void setContentType (int type)

the possible types here are triggers, subscriptions, devices

Parameters
type -- one of the values from constants defined in this interface

public abstract void setDeliveryMode (int deliveryMode)

Sets retrieval for components with specified delivery mode (EnumWebSubscriptionDeliveryMode). If unspecified, or set to -1, no delivery mode filtering is performed.

Parameters
deliveryMode the delivery mode.

public abstract void setSortAscending (boolean asc)

sets the sort order to be ascending or descending

Parameters
asc true indicates ascending and false indicates descending

public abstract void setSortField (int sortField)

sets the sort field

Parameters
sortField the field by which to sort on -- one of the values from WebSubscriptionsSource or {link com.microstrategy.web.objects.EnumWebScheduleSort} based on whether the bean corresponds to Email schedules or Web schedules respectively.

public abstract void setSortForDeliveryMode (int mode, int field, boolean ascending)

sets the sort field and order for the specified delivery mode

Parameters
mode int deliveryMode from EnumDSSXMLSubscriptionDeliveryType
field int field by which to sort on from WebSubscriptionsSource or {link com.microstrategy.web.objects.EnumWebScheduleSort} based on whether the bean corresponds to Email schedules or Web schedules respectively.

public abstract void setTarget (String ObjectID, int objectType)

sets the object for which components should be retrieved. If this target is not set, all the components for the user are retrieved

Parameters
ObjectID of a report/document
objectType value from the enumeration EnumDSSXMLObjectTypes can be either report or document
Throws
WebBeanException