WebScheduleTriggerTime
implements WebScheduleTrigger| com.microstrategy.web.objects.WebScheduleTriggerTime |
 Known Indirect Subclasses
|
Class Overview
This is the base class for all time trigger interfaces
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | TypeDayNumeric | Trigger Day types | |||||||||
| int | TypeDayOfWeek | Trigger Day types | |||||||||
| int | TypeHour | RepeatValueTypes | |||||||||
| int | TypeMinute | RepeatValueTypes | |||||||||
| int | daily | SubTypes | |||||||||
| int | monthly | SubTypes | |||||||||
| int | undefined | SubTypes | |||||||||
| int | weekly | SubTypes | |||||||||
| int | yearly | SubTypes | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
disableTriggerRepeat()
Prevents the trigger from firing multiple times on a trigger day
| ||||||||||
| abstract void |
enableTriggerRepeat(int type, int value)
This method is deprecated.
use
enableTriggerRepeat(int)
| ||||||||||
| abstract void |
enableTriggerRepeat(int value)
Enables the trigger to fire multiple times on the trigger day
| ||||||||||
| abstract int |
getMinutesAfterMidnight()
This method is deprecated.
use
getRepeatStart()
| ||||||||||
| abstract int |
getRepeatStart()
Returns the number of seconds after midnight that this trigger will begin
repeat firing.
| ||||||||||
| abstract int |
getRepeatStop()
Returns the number of seconds after midnight that this trigger will end
repeat firing.
| ||||||||||
| abstract int |
getRepeatValue()
Returns the number of minutes between same day firings
| ||||||||||
| abstract int |
getRepeatValueType()
This method is deprecated.
This interface only supports
TypeMinute as of 2009.05.07
| ||||||||||
| abstract int |
getTriggerSubType()
Returns the subtype of a time trigger
| ||||||||||
| abstract String |
getTriggerTime()
Returns text specifying the 24-hour time that the trigger will fire
once.
| ||||||||||
| abstract boolean |
isTriggerRepeatable()
Returns whether this trigger will fire repeatedly throughout the
trigger day
| ||||||||||
| abstract void |
setMinutesAfterMidnight(int minutes)
This method is deprecated.
use
setRepeatStart(int)
| ||||||||||
| abstract void |
setRepeatStart(int seconds)
Sets the number of seconds after midnight that the trigger will begin
repeat firing.
| ||||||||||
| abstract void |
setRepeatStop(int seconds)
Sets the number of seconds after midnight that this trigger will end
repeat firing.
| ||||||||||
| abstract void |
setTriggerTime(String time)
Sets the time at which the trigger will fire once.
| ||||||||||
|
[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
| |||||||||||
|
From interface
com.microstrategy.web.objects.WebScheduleTrigger
| |||||||||||
Constants
public static final int TypeDayNumeric
Trigger Day types
public static final int TypeDayOfWeek
Trigger Day types
public static final int TypeHour
RepeatValueTypes
public static final int TypeMinute
RepeatValueTypes
public static final int daily
SubTypes
public static final int monthly
SubTypes
public static final int undefined
SubTypes
public static final int weekly
SubTypes
public static final int yearly
SubTypes
Public Methods
public abstract void disableTriggerRepeat ()
Prevents the trigger from firing multiple times on a trigger day
public abstract void enableTriggerRepeat (int type, int value)
This method is deprecated.
use enableTriggerRepeat(int)
Enables the trigger to fire multiple times on the trigger day
Parameters
| type | int specifying whether the time between same day firings
will be measured in hours or minutes. See: TypeHour
and TypeMinute |
|---|---|
| value | int specifying the number of hours or minutes between same day firings. Must be between 1 and 23 for hours. |
public abstract void enableTriggerRepeat (int value)
Enables the trigger to fire multiple times on the trigger day
Parameters
| value | int specifying the number of minutes between same day firings |
|---|
public abstract int getMinutesAfterMidnight ()
This method is deprecated.
use getRepeatStart()
Returns the minutes after midnight that this trigger will begin
firing. Meaningless if TriggerRepeat is false or if RepeatValue is of
type TypeMinute
Returns
- int number of minutes after midnight that this trigger will begin firing
public abstract int getRepeatStart ()
Returns the number of seconds after midnight that this trigger will begin
repeat firing. Meaningless if isTriggerRepeatable() returns false
Returns
- int number of seconds after midnight to being repeat firing
public abstract int getRepeatStop ()
Returns the number of seconds after midnight that this trigger will end
repeat firing. Meaningless if isTriggerRepeatable() returns false
Returns
- int number of seconds after midnight to end repeat firing
public abstract int getRepeatValue ()
Returns the number of minutes between same day firings
Returns
- int value specifying the number of minutes between same day firings
public abstract int getRepeatValueType ()
This method is deprecated.
This interface only supports TypeMinute as of 2009.05.07
Returns the type specifying how the repeat value is to be interpretted
Returns
- int specifying how the repeat value is to be interpretted
(either
TypeHourorTypeMinute)
public abstract int getTriggerSubType ()
public abstract String getTriggerTime ()
Returns text specifying the 24-hour time that the trigger will fire once. NOTE: The returned string is meaningless if TriggerRepeat is enabled
Returns
- String containing the 24-hour time that the trigger will fire once
public abstract boolean isTriggerRepeatable ()
Returns whether this trigger will fire repeatedly throughout the trigger day
Returns
- boolean value specifying whether this trigger will fire multiple times on the trigger day
public abstract void setMinutesAfterMidnight (int minutes)
This method is deprecated.
use setRepeatStart(int)
Sets the number of minutes after midnight that the trigger will begin
firing. Action ignored if TriggerRepeat is false or if RepeatValue is of
type TypeMinute
Parameters
| minutes | int number of minutes |
|---|
public abstract void setRepeatStart (int seconds)
Sets the number of seconds after midnight that the trigger will begin repeat firing. Only pertinent if TriggerRepeat is enabled.
Parameters
| seconds | int number of seconds after midnight to begin repeat firing |
|---|
public abstract void setRepeatStop (int seconds)
Sets the number of seconds after midnight that this trigger will end repeat firing. Only pertinent off TriggerRepeat is enabled
Parameters
| seconds | int number of seconds after midnight to end repeat firing |
|---|
public abstract void setTriggerTime (String time)
Sets the time at which the trigger will fire once. NOTE: Disables TriggerRepeat
Parameters
| time | String containing time in either 12-hour (hh:mm:ss ?M) or 24-hour (hh:mm:ss) format |
|---|