Package com.microstrategy.web.objects
Interface WebScheduleTriggerTime
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
,WebScheduleTrigger
- All Known Subinterfaces:
WebScheduleTriggerTimeDaily
,WebScheduleTriggerTimeMonthly
,WebScheduleTriggerTimeWeekly
,WebScheduleTriggerTimeYearly
public interface WebScheduleTriggerTime extends WebScheduleTrigger
This is the base class for all time trigger interfaces- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
daily
SubTypesstatic int
monthly
SubTypesstatic int
TypeDayNumeric
Trigger Day typesstatic int
TypeDayOfWeek
Trigger Day typesstatic int
TypeHour
RepeatValueTypesstatic int
TypeMinute
RepeatValueTypesstatic int
undefined
SubTypesstatic int
weekly
SubTypesstatic int
yearly
SubTypes
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
disableTriggerRepeat()
Prevents the trigger from firing multiple times on a trigger dayvoid
enableTriggerRepeat(int value)
Enables the trigger to fire multiple times on the trigger dayvoid
enableTriggerRepeat(int type, int value)
Deprecated.int
getMinutesAfterMidnight()
Deprecated.usegetRepeatStart()
int
getRepeatStart()
Returns the number of seconds after midnight that this trigger will begin repeat firing.int
getRepeatStop()
Returns the number of seconds after midnight that this trigger will end repeat firing.int
getRepeatValue()
Returns the number of minutes between same day firingsint
getRepeatValueType()
Deprecated.This interface only supportsTypeMinute
as of 2009.05.07int
getTriggerSubType()
Returns the subtype of a time triggerjava.lang.String
getTriggerTime()
Returns text specifying the 24-hour time that the trigger will fire once.boolean
isTriggerRepeatable()
Returns whether this trigger will fire repeatedly throughout the trigger dayvoid
setMinutesAfterMidnight(int minutes)
Deprecated.void
setRepeatStart(int seconds)
Sets the number of seconds after midnight that the trigger will begin repeat firing.void
setRepeatStop(int seconds)
Sets the number of seconds after midnight that this trigger will end repeat firing.void
setTriggerTime(java.lang.String time)
Sets the time at which the trigger will fire once.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
Methods inherited from interface com.microstrategy.web.objects.WebScheduleTrigger
getNextDelivery, getNextDeliveryZonedDateTime, getStartDate, getStopDate, getTriggerType, isStopDateSet, setStartDate, setStopDate, setToDaily, setToEvent, setToMonthly, setToWeekly, setToYearly
-
-
-
-
Field Detail
-
TypeHour
static final int TypeHour
RepeatValueTypes- See Also:
- Constant Field Values
-
TypeMinute
static final int TypeMinute
RepeatValueTypes- See Also:
- Constant Field Values
-
daily
static final int daily
SubTypes- See Also:
- Constant Field Values
-
weekly
static final int weekly
SubTypes- See Also:
- Constant Field Values
-
monthly
static final int monthly
SubTypes- See Also:
- Constant Field Values
-
yearly
static final int yearly
SubTypes- See Also:
- Constant Field Values
-
undefined
static final int undefined
SubTypes- See Also:
- Constant Field Values
-
TypeDayNumeric
static final int TypeDayNumeric
Trigger Day types- See Also:
- Constant Field Values
-
TypeDayOfWeek
static final int TypeDayOfWeek
Trigger Day types- See Also:
- Constant Field Values
-
-
Method Detail
-
isTriggerRepeatable
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
-
enableTriggerRepeat
void enableTriggerRepeat(int type, int value)
Deprecated.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
andTypeMinute
value
- int specifying the number of hours or minutes between same day firings. Must be between 1 and 23 for hours.
-
enableTriggerRepeat
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
-
disableTriggerRepeat
void disableTriggerRepeat()
Prevents the trigger from firing multiple times on a trigger day
-
getTriggerTime
java.lang.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
-
setTriggerTime
void setTriggerTime(java.lang.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
-
getRepeatValue
int getRepeatValue()
Returns the number of minutes between same day firings- Returns:
- int value specifying the number of minutes between same day firings
-
getRepeatValueType
int getRepeatValueType()
Deprecated.This interface only supportsTypeMinute
as of 2009.05.07Returns the type specifying how the repeat value is to be interpretted- Returns:
- int specifying how the repeat value is to be interpretted
(either
TypeHour
orTypeMinute
)
-
getMinutesAfterMidnight
int getMinutesAfterMidnight()
Deprecated.usegetRepeatStart()
Returns the minutes after midnight that this trigger will begin firing. Meaningless if TriggerRepeat is false or if RepeatValue is of typeTypeMinute
- Returns:
- int number of minutes after midnight that this trigger will begin firing
-
setMinutesAfterMidnight
void setMinutesAfterMidnight(int minutes)
Deprecated.Sets the number of minutes after midnight that the trigger will begin firing. Action ignored if TriggerRepeat is false or if RepeatValue is of typeTypeMinute
- Parameters:
minutes
- int number of minutes
-
getRepeatStart
int getRepeatStart()
Returns the number of seconds after midnight that this trigger will begin repeat firing. Meaningless ifisTriggerRepeatable()
returns false- Returns:
- int number of seconds after midnight to being repeat firing
-
setRepeatStart
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
-
getRepeatStop
int getRepeatStop()
Returns the number of seconds after midnight that this trigger will end repeat firing. Meaningless ifisTriggerRepeatable()
returns false- Returns:
- int number of seconds after midnight to end repeat firing
-
setRepeatStop
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
-
-