public interface

WebScheduleTrigger

implements WebObjectInfo
com.microstrategy.web.objects.WebScheduleTrigger
Known Indirect Subclasses

Class Overview

WebScheduleTrigger represents a trigger on the Intelligence Server. This trigger object can be time-based or event-based.

Summary

Public Methods
abstract String getStartDate()
Returns the date after which this trigger will be active
abstract String getStopDate()
Returns the date after which this trigger will be inactive.
abstract int getTriggerType()
Returns the type of Trigger this is
abstract boolean isStopDateSet()
Returns whether the stop date is set for this trigger
abstract void setStartDate(String date)
Sets the date after which this trigger will be active
abstract void setStopDate(String date)
Sets the date after which this trigger will no longer fire.
abstract WebScheduleTriggerTimeDaily setToDaily()
Return this trigger object as Daily Trigger.
abstract WebScheduleTriggerEvent setToEvent()
Return this trigger object as Event Trigger.
abstract WebScheduleTriggerTimeMonthly setToMonthly()
Return this trigger object as Monthly Trigger.
abstract WebScheduleTriggerTimeWeekly setToWeekly()
Return this trigger object as Weekly Trigger.
abstract WebScheduleTriggerTimeYearly setToYearly()
Return this trigger object as Yearly Trigger.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract String getStartDate ()

Returns the date after which this trigger will be active

Returns
  • String containing mm/dd/yyyy formatted date

public abstract String getStopDate ()

Returns the date after which this trigger will be inactive. Only meaningful if stop date is set. Use isStopDateSet() to verify that stop date is set

Returns
  • String containing mm/dd/yyyy formatted date

public abstract int getTriggerType ()

Returns the type of Trigger this is

Returns

public abstract boolean isStopDateSet ()

Returns whether the stop date is set for this trigger

Returns
  • boolean value stating whether the stop date is set for this trigger

public abstract void setStartDate (String date)

Sets the date after which this trigger will be active

Parameters
date String containing mm/dd/yy or mm/dd/yyyy formatted date. Empty or null string will result in no stop date for this trigger

public abstract void setStopDate (String date)

Sets the date after which this trigger will no longer fire.

Parameters
date String containing mm/dd/yy or mm/dd/yyyy formatted date. Empty or null string will result in no stop date for this trigger

public abstract WebScheduleTriggerTimeDaily setToDaily ()

Return this trigger object as Daily Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

public abstract WebScheduleTriggerEvent setToEvent ()

Return this trigger object as Event Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

public abstract WebScheduleTriggerTimeMonthly setToMonthly ()

Return this trigger object as Monthly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

public abstract WebScheduleTriggerTimeWeekly setToWeekly ()

Return this trigger object as Weekly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

public abstract WebScheduleTriggerTimeYearly setToYearly ()

Return this trigger object as Yearly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns