Package com.microstrategy.web.objects
Interface WebScheduleTriggerTimeMonthly
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
,WebScheduleTrigger
,WebScheduleTriggerTime
public interface WebScheduleTriggerTimeMonthly extends WebScheduleTriggerTime
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
firstBusinessDay
BusinessDayOffset Typesstatic int
firstWeek
WeekOffset Typesstatic int
fourthWeek
WeekOffset Typesstatic int
lastBusinessDay
BusinessDayOffset Typesstatic int
lastDayOffset
LastDayOffset Typesstatic int
lastWeek
WeekOffset Typesstatic int
secondWeek
WeekOffset Typesstatic int
thirdWeek
WeekOffset Typesstatic int
TypeDayBusiness
Trigger Day types, extendedstatic int
TypeDayLast
Trigger Day types, extendedstatic int
TypeDaysOfMonth
Trigger Day types, extended-
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
getBusinessDayOffset()
Returns the business day offset that the trigger will fire.int
getDate()
Returns the date this trigger will fire each month.int
getDayOfWeek()
Returns the day of the week that the trigger will fire.int
getLastDayOffset()
Returns last day offset that the trigger will fire.int
getMonthlyDays()
Returns the days of the month that the trigger will fire.int
getMonthlyRepeatValue()
Returns the number of months this trigger will wait to fire againint
getMonthlyType()
Returns the type of MonthlyTrigger this is, indicating whether the trigger day will be specified byWebScheduleTriggerTime.TypeDayNumeric
or byWebScheduleTriggerTime.TypeDayOfWeek
int
getWeekOffset()
Returns which week the trigger will fire on each month.void
setBusinessDayOffset(int businessDayOffset)
Sets the business day offset that the trigger will fire.void
setDate(int date)
Sets the date this trigger will fire each month.void
setDayOfWeek(int day)
Sets teh day of week that the trigger will fire on.void
setLastDayOffset(int lastDayOffset)
Sets the last day offset that the trigger will fire.void
setMonthlyDays(int days)
Sets the days of the month that the trigger will fire This is ignored unless MonthlyType is set toTypeDaysOfMonth
.void
setMonthlyRepeatValue(int value)
Sets the number of months this trigger will wait to fire againvoid
setMonthlyType(int type)
Sets teh type of MonthlyTrigger this is, indicating whether the trigger day will be specified byWebScheduleTriggerTime.TypeDayNumeric
or byWebScheduleTriggerTime.TypeDayOfWeek
void
setWeekOffset(int offset)
Sets which week the trigger will fire on each month.-
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
-
firstWeek
static final int firstWeek
WeekOffset Types- See Also:
- Constant Field Values
-
secondWeek
static final int secondWeek
WeekOffset Types- See Also:
- Constant Field Values
-
thirdWeek
static final int thirdWeek
WeekOffset Types- See Also:
- Constant Field Values
-
fourthWeek
static final int fourthWeek
WeekOffset Types- See Also:
- Constant Field Values
-
lastWeek
static final int lastWeek
WeekOffset Types- See Also:
- Constant Field Values
-
TypeDayBusiness
static final int TypeDayBusiness
Trigger Day types, extended- See Also:
- Constant Field Values
-
TypeDayLast
static final int TypeDayLast
Trigger Day types, extended- See Also:
- Constant Field Values
-
TypeDaysOfMonth
static final int TypeDaysOfMonth
Trigger Day types, extended- See Also:
- Constant Field Values
-
firstBusinessDay
static final int firstBusinessDay
BusinessDayOffset Types- See Also:
- Constant Field Values
-
lastBusinessDay
static final int lastBusinessDay
BusinessDayOffset Types- See Also:
- Constant Field Values
-
lastDayOffset
static final int lastDayOffset
LastDayOffset Types- See Also:
- Constant Field Values
-
-
Method Detail
-
getMonthlyRepeatValue
int getMonthlyRepeatValue()
Returns the number of months this trigger will wait to fire again- Returns:
- int value representing the number of months between firings
-
setMonthlyRepeatValue
void setMonthlyRepeatValue(int value)
Sets the number of months this trigger will wait to fire again- Parameters:
value
- int value representing the number of months between firings
-
getDate
int getDate()
Returns the date this trigger will fire each month. Ignored unless MonthlyType is set toWebScheduleTriggerTime.TypeDayNumeric
- Returns:
- int date this trigger will fire each month.
-
setDate
void setDate(int date)
Sets the date this trigger will fire each month. Ignored unless MonthlyType is set toWebScheduleTriggerTime.TypeDayNumeric
- Parameters:
date
- int date this trigger will fire each month
-
getWeekOffset
int getWeekOffset()
Returns which week the trigger will fire on each month. Associated with the DayOfWeek value and is ignored unless MonthlyType is set toWebScheduleTriggerTime.TypeDayOfWeek
- Returns:
- int number of weeks after beginning of month that trigger
will fire. See:
firstWeek
,secondWeek
,thirdWeek
,fourthWeek
,lastWeek
-
setWeekOffset
void setWeekOffset(int offset)
Sets which week the trigger will fire on each month. Associated with the DayOfWeek value and is ignored unless MonthlyType is set toWebScheduleTriggerTime.TypeDayOfWeek
.- Parameters:
offset
- int specifying which week of the month this trigger will fire. Must be one offirstWeek
,secondWeek
,thirdWeek
,fourthWeek
,lastWeek
-
getDayOfWeek
int getDayOfWeek()
Returns the day of the week that the trigger will fire. In conjunction with WeekOffset, this specifies a single day each month for the trigger to fire.- Returns:
- int value from
EnumDSSXMLDayOfWeekBitEncoded
-
setDayOfWeek
void setDayOfWeek(int day)
Sets teh day of week that the trigger will fire on. In conjunction with WeekOffset, this specifies a single day each month for the trigger to fire.- Parameters:
day
- int value fromEnumDSSXMLDayOfWeekBitEncoded
-
getBusinessDayOffset
int getBusinessDayOffset()
Returns the business day offset that the trigger will fire. This is ignored unless MonthlyType is set toTypeDayBusiness
This specifies a business day each month for the trigger to fire.- Returns:
- int of business day offset.
See:
firstBusinessDay
,lastBusinessDay
-
setBusinessDayOffset
void setBusinessDayOffset(int businessDayOffset)
Sets the business day offset that the trigger will fire. This is ignored unless MonthlyType is set toTypeDayBusiness
This specifies a business day each month for the trigger to fire.- Parameters:
businessDayOffset
- int of business day offset. Must be one offirstBusinessDay
,lastBusinessDay
-
getMonthlyDays
int getMonthlyDays()
Returns the days of the month that the trigger will fire. This is ignored unless MonthlyType is set toTypeDaysOfMonth
- Returns:
- int bit-wise OR of values from
EnumDSSXMLDayOfMonthBitEncoded
-
setMonthlyDays
void setMonthlyDays(int days)
Sets the days of the month that the trigger will fire This is ignored unless MonthlyType is set toTypeDaysOfMonth
.- Parameters:
days
- integer bit-wise OR of values fromEnumDSSXMLDayOfMonthBitEncoded
-
getLastDayOffset
int getLastDayOffset()
Returns last day offset that the trigger will fire. This is ignored unless MonthlyType is set toTypeDayLast
This specifies last day of each month for the trigger to fire.- Returns:
- int of last day offset.
See:
lastDayOffset
-
setLastDayOffset
void setLastDayOffset(int lastDayOffset)
Sets the last day offset that the trigger will fire. This is ignored unless MonthlyType is set toTypeDayLast
This specifies last day of each month for the trigger to fire.- Parameters:
lastDayOffset
- int of last day offset. See:lastDayOffset
-
getMonthlyType
int getMonthlyType()
Returns the type of MonthlyTrigger this is, indicating whether the trigger day will be specified byWebScheduleTriggerTime.TypeDayNumeric
or byWebScheduleTriggerTime.TypeDayOfWeek
- Returns:
- int value. See
WebScheduleTriggerTime.TypeDayNumeric
,WebScheduleTriggerTime.TypeDayOfWeek
Newly addedTypeDayBusiness
,TypeDayLast
TypeDaysOfMonth
-
setMonthlyType
void setMonthlyType(int type)
Sets teh type of MonthlyTrigger this is, indicating whether the trigger day will be specified byWebScheduleTriggerTime.TypeDayNumeric
or byWebScheduleTriggerTime.TypeDayOfWeek
- Parameters:
type
- int value. SeeWebScheduleTriggerTime.TypeDayNumeric
,WebScheduleTriggerTime.TypeDayOfWeek
Newly addedTypeDayBusiness
,TypeDayLast
TypeDaysOfMonth
-
-