public interface

WebScheduleTriggerTimeMonthly

implements WebScheduleTriggerTime
com.microstrategy.web.objects.WebScheduleTriggerTimeMonthly

Summary

Constants
int firstWeek WeekOffset Types
int fourthWeek WeekOffset Types
int lastWeek WeekOffset Types
int secondWeek WeekOffset Types
int thirdWeek WeekOffset Types
[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.WebScheduleTriggerTime
Public Methods
abstract int getDate()
Returns the date this trigger will fire each month.
abstract int getDayOfWeek()
Returns the day of the week that the trigger will fire.
abstract int getMonthlyRepeatValue()
Returns the number of months this trigger will wait to fire again
abstract int getMonthlyType()
Returns the type of MonthlyTrigger this is, indicating whether the trigger day will be specified by TypeDayNumeric or by TypeDayOfWeek
abstract int getWeekOffset()
Returns which week the trigger will fire on each month.
abstract void setDate(int date)
Sets the date this trigger will fire each month.
abstract void setDayOfWeek(int day)
Sets teh day of week that the trigger will fire on.
abstract void setMonthlyRepeatValue(int value)
Sets the number of months this trigger will wait to fire again
abstract void setMonthlyType(int type)
Sets teh type of MonthlyTrigger this is, indicating whether the trigger day will be specified by TypeDayNumeric or by TypeDayOfWeek
abstract void setWeekOffset(int offset)
Sets which week the trigger will fire on each month.
[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
From interface com.microstrategy.web.objects.WebScheduleTriggerTime

Constants

public static final int firstWeek

WeekOffset Types

Constant Value: 1 (0x00000001)

public static final int fourthWeek

WeekOffset Types

Constant Value: 4 (0x00000004)

public static final int lastWeek

WeekOffset Types

Constant Value: 5 (0x00000005)

public static final int secondWeek

WeekOffset Types

Constant Value: 2 (0x00000002)

public static final int thirdWeek

WeekOffset Types

Constant Value: 3 (0x00000003)

Public Methods

public abstract int getDate ()

Returns the date this trigger will fire each month. Ignored unless MonthlyType is set to TypeDayNumeric

Returns
  • int date this trigger will fire each month.

public abstract 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

public abstract int getMonthlyRepeatValue ()

Returns the number of months this trigger will wait to fire again

Returns
  • int value representing the number of months between firings

public abstract int getMonthlyType ()

Returns the type of MonthlyTrigger this is, indicating whether the trigger day will be specified by TypeDayNumeric or by TypeDayOfWeek

Returns

public abstract int getWeekOffset ()

Returns which week the trigger will fire on each month. Associated with the DayOfWeek value and is ignored unless MonthlyType is set to TypeDayOfWeek

Returns

public abstract void setDate (int date)

Sets the date this trigger will fire each month. Ignored unless MonthlyType is set to TypeDayNumeric

Parameters
date int date this trigger will fire each month

public abstract 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 from EnumDSSXMLDayOfWeekBitEncoded

public abstract 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

public abstract void setMonthlyType (int type)

Sets teh type of MonthlyTrigger this is, indicating whether the trigger day will be specified by TypeDayNumeric or by TypeDayOfWeek

Parameters
type int value. See TypeDayNumeric, TypeDayOfWeek

public abstract 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 to TypeDayOfWeek.

Parameters
offset int specifying which week of the month this trigger will fire. Must be one of firstWeek, secondWeek, thirdWeek, fourthWeek, lastWeek