Package com.microstrategy.web.objects
Interface WebScheduleTriggerTimeYearly
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
,WebScheduleTrigger
,WebScheduleTriggerTime
public interface WebScheduleTriggerTimeYearly extends WebScheduleTriggerTime
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
April
Month enumerationstatic int
August
Month enumerationstatic int
December
Month enumerationstatic int
February
Month enumerationstatic int
January
Month enumerationstatic int
July
Month enumerationstatic int
June
Month enumerationstatic int
March
Month enumerationstatic int
May
Month enumerationstatic int
November
Month enumerationstatic int
October
Month enumerationstatic int
September
Month enumeration-
Fields inherited from interface com.microstrategy.web.objects.WebScheduleTriggerTime
daily, monthly, TypeDayNumeric, TypeDayOfWeek, TypeHour, TypeMinute, undefined, weekly, yearly
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getMonth()
Return the month this trigger will fire.int
getYearlyDate()
Return the date associated with this triggerint
getYearlyDayOfWeek()
Return the day of week value stored in this triggerint
getYearlyType()
Return the type of day that will be used in this triggerint
getYearlyWeekOffset()
Return the week that this trigger will fire invoid
setMonth(int month)
Set the month that this trigger will firevoid
setYearlyDate(int date)
Set the date associated with this triggervoid
setYearlyDayOfWeek(int dow)
Set the day of week value for this triggervoid
setYearlyType(int type)
Set the type of day that will be used as this trigger dayvoid
setYearlyWeekOffset(int offset)
Set the week that this trigger will fire in-
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
-
Methods inherited from interface com.microstrategy.web.objects.WebScheduleTriggerTime
disableTriggerRepeat, enableTriggerRepeat, enableTriggerRepeat, getMinutesAfterMidnight, getRepeatStart, getRepeatStop, getRepeatValue, getRepeatValueType, getTriggerSubType, getTriggerTime, isTriggerRepeatable, setMinutesAfterMidnight, setRepeatStart, setRepeatStop, setTriggerTime
-
-
-
-
Field Detail
-
January
static final int January
Month enumeration- See Also:
- Constant Field Values
-
February
static final int February
Month enumeration- See Also:
- Constant Field Values
-
March
static final int March
Month enumeration- See Also:
- Constant Field Values
-
April
static final int April
Month enumeration- See Also:
- Constant Field Values
-
May
static final int May
Month enumeration- See Also:
- Constant Field Values
-
June
static final int June
Month enumeration- See Also:
- Constant Field Values
-
July
static final int July
Month enumeration- See Also:
- Constant Field Values
-
August
static final int August
Month enumeration- See Also:
- Constant Field Values
-
September
static final int September
Month enumeration- See Also:
- Constant Field Values
-
October
static final int October
Month enumeration- See Also:
- Constant Field Values
-
November
static final int November
Month enumeration- See Also:
- Constant Field Values
-
December
static final int December
Month enumeration- See Also:
- Constant Field Values
-
-
Method Detail
-
getYearlyDayOfWeek
int getYearlyDayOfWeek()
Return the day of week value stored in this trigger- Returns:
- int day of week from
EnumDSSXMLDayOfWeekBitEncoded
-
setYearlyDayOfWeek
void setYearlyDayOfWeek(int dow)
Set the day of week value for this trigger- Parameters:
dow
- int fromEnumDSSXMLDayOfWeekBitEncoded
. Can only contain a single day/bit
-
getYearlyDate
int getYearlyDate()
Return the date associated with this trigger- Returns:
- int between 1 and 31
-
setYearlyDate
void setYearlyDate(int date)
Set the date associated with this trigger- Parameters:
date
- int between 1 and 31
-
getYearlyWeekOffset
int getYearlyWeekOffset()
Return the week that this trigger will fire in- Returns:
- int week number between
WebScheduleTriggerTimeMonthly.firstWeek
andWebScheduleTriggerTimeMonthly.lastWeek
-
setYearlyWeekOffset
void setYearlyWeekOffset(int offset)
Set the week that this trigger will fire in- Parameters:
offset
- int week number betweenWebScheduleTriggerTimeMonthly.firstWeek
andWebScheduleTriggerTimeMonthly.lastWeek
-
getMonth
int getMonth()
Return the month this trigger will fire.- Returns:
- int value of month. See
January
, etc.
-
setMonth
void setMonth(int month)
Set the month that this trigger will fire
-
getYearlyType
int getYearlyType()
Return the type of day that will be used in this trigger- Returns:
- int type of day. Either
WebScheduleTriggerTime.TypeDayNumeric
orWebScheduleTriggerTime.TypeDayOfWeek
-
setYearlyType
void setYearlyType(int type)
Set the type of day that will be used as this trigger day- Parameters:
type
- int type of day. EitherWebScheduleTriggerTime.TypeDayNumeric
orWebScheduleTriggerTime.TypeDayOfWeek
-
-