public interface

ScheduleBean

implements WebBean
com.microstrategy.web.beans.ScheduleBean

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

Class Overview

This bean represents an Intelligence server schedule. The important functionality this bean provides is:

  • creating new schedule by defining appropriate content, trigger and personalization
  • edit an existing schedule
  • delete an existing schedule
This bean can be created using newScheduleBean() Once created, the bean needs to associated with a content and a trigger before it can be saved The content is defined using a valid report/document. This is set using setContent(String, int). The trigger to be used with this schedule is defined by adding a new trigger ID to the list retrieved using getTriggers().

See Also

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void cancel()
sets the bean state to cancel
abstract void delete()
This method deletes the subscription that the bean was initialized with using the setSubscriptionID method.
abstract SimpleList getAvailableTriggers()
Returns a read-only list of all the possible triggers (that are accesible to this user session) from which the user can pick for creating a schedule
abstract WebObjectInfo getContent()
abstract WebSchedule getDuplicate()
abstract int getExecutionFlags()
returns the execution flags.
abstract WebSchedule getMobileDuplicate()
abstract boolean getOverwrite()
indicates whether the overwrite flag is set
abstract PromptsBean getPromptsBean()
Returns the embedded PromptsBean.
abstract WebEventHandler getPromptsEventHandler()
Gets the prompts event handler that is associated with the underlying promptsbean.
abstract boolean getReuseMessage()
Return true if the Inbox message is reused.
abstract ObjectBean getTarget()
retrieves the object for which this schedule is being created Returns null if either no content was set using setContent(String, int) or no existing schedule was associated with this bean using setSchedule(String, String, int)
abstract SimpleList getTriggers()
Returns an editable list.
abstract int getViewMode()
Only relevant in the case of a report subscription.
abstract boolean isMobileEnabled()
abstract boolean isPersonalized()
returns true indicating whether the schedule is personalized This means that the content (report or document) used for this schedule was prompted
abstract void reprompt()
Reopens the answered prompts, if thers is any, contained in this ScheduleBean.
abstract void save()
This method saves the schedule for the specified content and list of triggers Once the save method completes, the list of triggers is reset.
abstract void setContent(String objectID, int objectType)
This defines the content for this schedule.
abstract void setDuplicate(WebSchedule value)
abstract void setExecutionFlags(int executionFlags)
sets the execution flags.
abstract void setMobileDuplicate(WebSchedule value)
abstract void setMobileEnabled(boolean enable)
abstract void setOverwrite(boolean flag)
used to indicate whether an existing schedule should be overwritten when the save call is made
abstract void setPromptsEventHandler(WebEventHandler promptsEventHandler)
Sets the prompts event handler of the underlying prompts bean.
abstract void setReuseMessage(boolean flag)
used to indicate whether the message in inbox should be reused
abstract void setSchedule(String triggerID, String objectID, int objectType)
This method is used to initialize the bean with an existing schedule.
abstract void setViewMode(int mode)
Only relevant in the case of a report subscription.
[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

Public Methods

public abstract void cancel ()

sets the bean state to cancel

public abstract void delete ()

This method deletes the subscription that the bean was initialized with using the setSubscriptionID method. If the bean was not initialized in this way, then this call has no effect.

Throws
WebBeanException thrown if there is an error while deleting

public abstract SimpleList getAvailableTriggers ()

Returns a read-only list of all the possible triggers (that are accesible to this user session) from which the user can pick for creating a schedule

Returns
  • read-only list of all triggers
Throws
WebBeanException

public abstract WebObjectInfo getContent ()

Returns
  • a WebObjectInfo representing the content (either report/document) for which this schedule is being created
Throws
WebBeanException thrown if the content can not be retrieved.

public abstract WebSchedule getDuplicate ()

public abstract int getExecutionFlags ()

returns the execution flags.

public abstract WebSchedule getMobileDuplicate ()

public abstract boolean getOverwrite ()

indicates whether the overwrite flag is set

Returns
  • boolean indicating whether the overwrite flag is set

public abstract PromptsBean getPromptsBean ()

Returns the embedded PromptsBean. The returned PromptsBean is empty if this schedule does not have contain any prompts.

Returns
  • the embedded PromptsBean.

public abstract WebEventHandler getPromptsEventHandler ()

Gets the prompts event handler that is associated with the underlying promptsbean. This is just a convenience method. The result of this is the same as this.getPromptsBean().getWebEventHandler()

Returns
  • the prompts event handler
See Also

public abstract boolean getReuseMessage ()

Return true if the Inbox message is reused. As the schedule gets triggered multiple times, This flag indicates to the server if it should keep creating new versions of the message or overwrite the existing version (i.e. maintain only one version)

Returns
  • boolean indicating whether the message in the inbox should be reused

public abstract ObjectBean getTarget ()

retrieves the object for which this schedule is being created Returns null if either no content was set using setContent(String, int) or no existing schedule was associated with this bean using setSchedule(String, String, int)

Returns
  • the object bean.
Throws
WebBeanException
WebBeanException

public abstract SimpleList getTriggers ()

Returns an editable list. This is a convenience mechanism for the user to create multiple schedules at once. when save() on this bean is called, schedules are created for each of the triggers that are a part of this list. The list is cleared after a successful completion the save() call. If the bean represents an existing schedule (see setSchedule(String, String, int)), then the triggers list is initialized with the trigger that the schedule is associated with.

Returns
See Also

public abstract int getViewMode ()

Only relevant in the case of a report subscription. It indicates whether the view mode is grid, graph or both possible values are defined in EnumWebReportViewMode

Returns
  • the report view mode

public abstract boolean isMobileEnabled ()

public abstract boolean isPersonalized ()

returns true indicating whether the schedule is personalized This means that the content (report or document) used for this schedule was prompted

Returns
  • true if the subscription is personalized
Throws
WebBeanException thrown if error occurs

public abstract void reprompt ()

Reopens the answered prompts, if thers is any, contained in this ScheduleBean.

Throws
WebBeanException thrown if error occurs when refreshing.

public abstract void save ()

This method saves the schedule for the specified content and list of triggers Once the save method completes, the list of triggers is reset. In other words, the getTriggers call would return an empty list

Throws
WebBeanException thrown if there is an error while saving

public abstract void setContent (String objectID, int objectType)

This defines the content for this schedule.

Parameters
objectID ID of a report/document
objectType indicates whether it's a report or a document, a value from EnumDSSXMLObjectTypes
Throws
WebBeanException if the objectID or the objectType are invalid

public abstract void setDuplicate (WebSchedule value)

public abstract void setExecutionFlags (int executionFlags)

sets the execution flags.

public abstract void setMobileDuplicate (WebSchedule value)

public abstract void setMobileEnabled (boolean enable)

public abstract void setOverwrite (boolean flag)

used to indicate whether an existing schedule should be overwritten when the save call is made

See Also

public abstract void setPromptsEventHandler (WebEventHandler promptsEventHandler)

Sets the prompts event handler of the underlying prompts bean. This is just a convenience method. The effect of this is the same as doing this.getPromptsBean().setWebEventHandler(promptsEventHandler)

Parameters
promptsEventHandler of the underlying prompts bean.

public abstract void setReuseMessage (boolean flag)

used to indicate whether the message in inbox should be reused

Parameters
flag used to indicate whether the message in inbox should be reused
See Also

public abstract void setSchedule (String triggerID, String objectID, int objectType)

This method is used to initialize the bean with an existing schedule. This retrieves the complete schedule definition from the server

Parameters
triggerID a schedule trigger ID
objectID ID of a report/document
objectType the object type (EnumDSSXMLObjectTypes) of a report or document.
Throws
WebBeanException thrown if the parameters passed in do not correspond to an existing schedule

public abstract void setViewMode (int mode)

Only relevant in the case of a report subscription. It indicates whether the view mode is grid, graph or both

Parameters
mode one of the possible values from EnumWebReportViewMode