Package com.microstrategy.web.beans

Interface ScheduleBean

All Superinterfaces:

EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebBean, WebComponent

public interface ScheduleBean
extends WebBean

Deprecated.

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

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 WebBeanFactory.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().

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

SubscriptionBean

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

Modifier and Type	Method	Description
void	cancel()	Deprecated. sets the bean state to cancel
void	delete()	Deprecated. This method deletes the subscription that the bean was initialized with using the setSubscriptionID method.
SimpleList	getAvailableTriggers()	Deprecated. 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
WebObjectInfo	getContent()	Deprecated.
WebSchedule	getDuplicate()	Deprecated.
int	getExecutionFlags()	Deprecated. returns the execution flags.
WebSchedule	getMobileDuplicate()	Deprecated.
boolean	getOverwrite()	Deprecated. indicates whether the overwrite flag is set
PromptsBean	getPromptsBean()	Deprecated. Returns the embedded PromptsBean.
WebEventHandler	getPromptsEventHandler()	Deprecated. Gets the prompts event handler that is associated with the underlying promptsbean.
boolean	getReuseMessage()	Deprecated. Return true if the Inbox message is reused.
ObjectBean	getTarget()	Deprecated. 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)
SimpleList	getTriggers()	Deprecated. Returns an editable list.
int	getViewMode()	Deprecated. Only relevant in the case of a report subscription.
boolean	isMobileEnabled()	Deprecated.
boolean	isPersonalized()	Deprecated. returns true indicating whether the schedule is personalized This means that the content (report or document) used for this schedule was prompted
void	reprompt()	Deprecated. Reopens the answered prompts, if thers is any, contained in this ScheduleBean.
void	save()	Deprecated. This method saves the schedule for the specified content and list of triggers Once the save method completes, the list of triggers is reset.
void	setContent(java.lang.String objectID, int objectType)	Deprecated. This defines the content for this schedule.
void	setDuplicate(WebSchedule value)	Deprecated.
void	setExecutionFlags(int executionFlags)	Deprecated. sets the execution flags.
void	setMobileDuplicate(WebSchedule value)	Deprecated.
void	setMobileEnabled(boolean enable)	Deprecated.
void	setOverwrite(boolean flag)	Deprecated. used to indicate whether an existing schedule should be overwritten when the save call is made
void	setPromptsEventHandler(WebEventHandler promptsEventHandler)	Deprecated. Sets the prompts event handler of the underlying prompts bean.
void	setReuseMessage(boolean flag)	Deprecated. used to indicate whether the message in inbox should be reused
void	setSchedule(java.lang.String triggerID, java.lang.String objectID, int objectType)	Deprecated. This method is used to initialize the bean with an existing schedule.
void	setViewMode(int mode)	Deprecated. Only relevant in the case of a report subscription.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebBean

getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

getPromptsBean

PromptsBean getPromptsBean()

Deprecated.

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

Returns:

the embedded PromptsBean.

getTriggers

SimpleList getTriggers()

Deprecated.

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:

a SimpleList of triggerIDs

See Also:

WebScheduleTrigger

setContent

void setContent(java.lang.String objectID,
                int objectType)
         throws WebBeanException

Deprecated.

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

setSchedule

void setSchedule(java.lang.String triggerID,
                 java.lang.String objectID,
                 int objectType)
          throws WebBeanException

Deprecated.

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

isPersonalized

boolean isPersonalized()
                throws WebBeanException

Deprecated.

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

save

void save()
   throws WebBeanException

Deprecated.

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

delete

void delete()
     throws WebBeanException

Deprecated.

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

getPromptsEventHandler

WebEventHandler getPromptsEventHandler()

Deprecated.

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:

getPromptsBean()

setPromptsEventHandler

void setPromptsEventHandler(WebEventHandler promptsEventHandler)

Deprecated.

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.

cancel

void cancel()

Deprecated.

sets the bean state to cancel

getAvailableTriggers

SimpleList getAvailableTriggers()
                         throws WebBeanException

Deprecated.

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

getContent

WebObjectInfo getContent()
                  throws WebBeanException

Deprecated.

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.

setOverwrite

void setOverwrite(boolean flag)

Deprecated.

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

Parameters:

flag -

See Also:

getOverwrite()

getOverwrite

boolean getOverwrite()

Deprecated.

indicates whether the overwrite flag is set

Returns:

boolean indicating whether the overwrite flag is set

setReuseMessage

void setReuseMessage(boolean flag)

Deprecated.

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:

getReuseMessage()

setExecutionFlags

void setExecutionFlags(int executionFlags)

Deprecated.

sets the execution flags.

Parameters:

executionFlags -

Since:

MicroStrategy Web 8.0.1

getExecutionFlags

int getExecutionFlags()

Deprecated.

returns the execution flags.

Since:

MicroStrategy Web 8.0.1

getReuseMessage

boolean getReuseMessage()

Deprecated.

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

getViewMode

int getViewMode()

Deprecated.

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

setViewMode

void setViewMode(int mode)

Deprecated.

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

getTarget

ObjectBean getTarget()
              throws WebBeanException

Deprecated.

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

Since:

MicroStrategy Web 8.0.0

reprompt

void reprompt()
       throws WebBeanException

Deprecated.

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

Throws:

WebBeanException - thrown if error occurs when refreshing.

Since:

MicroStrategy Web 8.0.0

isMobileEnabled

boolean isMobileEnabled()

Deprecated.

Since:

MicroStrategy Web 8.1.1

setMobileEnabled

void setMobileEnabled(boolean enable)

Deprecated.

Since:

MicroStrategy Web 8.1.1

getDuplicate

WebSchedule getDuplicate()

Deprecated.

Since:

MicroStrategy Web 8.1.1

setDuplicate

void setDuplicate(WebSchedule value)

Deprecated.

Since:

MicroStrategy Web 8.1.1

getMobileDuplicate

WebSchedule getMobileDuplicate()

Deprecated.

Since:

MicroStrategy Web 8.1.1

setMobileDuplicate

void setMobileDuplicate(WebSchedule value)

Deprecated.

Since:

MicroStrategy Web 8.1.1