public
interface
WebScheduleTriggerTimeYearly
implements WebScheduleTriggerTime| com.microstrategy.web.objects.WebScheduleTriggerTimeYearly |
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | April | Month enumeration | |||||||||
| int | August | Month enumeration | |||||||||
| int | December | Month enumeration | |||||||||
| int | February | Month enumeration | |||||||||
| int | January | Month enumeration | |||||||||
| int | July | Month enumeration | |||||||||
| int | June | Month enumeration | |||||||||
| int | March | Month enumeration | |||||||||
| int | May | Month enumeration | |||||||||
| int | November | Month enumeration | |||||||||
| int | October | Month enumeration | |||||||||
| int | September | Month enumeration | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.web.objects.WebScheduleTriggerTime
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
getMonth()
Return the month this trigger will fire.
| ||||||||||
| abstract int |
getYearlyDate()
Return the date associated with this trigger
| ||||||||||
| abstract int |
getYearlyDayOfWeek()
Return the day of week value stored in this trigger
| ||||||||||
| abstract int |
getYearlyType()
Return the type of day that will be used in this trigger
| ||||||||||
| abstract int |
getYearlyWeekOffset()
Return the week that this trigger will fire in
| ||||||||||
| abstract void |
setMonth(int month)
Set the month that this trigger will fire
| ||||||||||
| abstract void |
setYearlyDate(int date)
Set the date associated with this trigger
| ||||||||||
| abstract void |
setYearlyDayOfWeek(int dow)
Set the day of week value for this trigger
| ||||||||||
| abstract void |
setYearlyType(int type)
Set the type of day that will be used as this trigger day
| ||||||||||
| abstract void |
setYearlyWeekOffset(int offset)
Set the week that this trigger will fire in
| ||||||||||
|
[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 April
Month enumeration
Constant Value:
4
(0x00000004)
public static final int August
Month enumeration
Constant Value:
8
(0x00000008)
public static final int December
Month enumeration
Constant Value:
12
(0x0000000c)
public static final int February
Month enumeration
Constant Value:
2
(0x00000002)
public static final int January
Month enumeration
Constant Value:
1
(0x00000001)
public static final int July
Month enumeration
Constant Value:
7
(0x00000007)
public static final int June
Month enumeration
Constant Value:
6
(0x00000006)
public static final int March
Month enumeration
Constant Value:
3
(0x00000003)
public static final int May
Month enumeration
Constant Value:
5
(0x00000005)
public static final int November
Month enumeration
Constant Value:
11
(0x0000000b)
public static final int October
Month enumeration
Constant Value:
10
(0x0000000a)
public static final int September
Month enumeration
Constant Value:
9
(0x00000009)
Public Methods
public abstract int getMonth ()
Return the month this trigger will fire.
Returns
- int value of month. See
January, etc.
public abstract int getYearlyDate ()
Return the date associated with this trigger
Returns
- int between 1 and 31
public abstract int getYearlyDayOfWeek ()
Return the day of week value stored in this trigger
Returns
- int day of week from
EnumDSSXMLDayOfWeekBitEncoded
public abstract int getYearlyType ()
Return the type of day that will be used in this trigger
Returns
- int type of day. Either
TypeDayNumericorTypeDayOfWeek
public abstract int getYearlyWeekOffset ()
public abstract void setMonth (int month)
public abstract void setYearlyDate (int date)
Set the date associated with this trigger
Parameters
| date | int between 1 and 31 |
|---|
public abstract void setYearlyDayOfWeek (int dow)
Set the day of week value for this trigger
Parameters
| dow | int from EnumDSSXMLDayOfWeekBitEncoded. Can only
contain a single day/bit
|
|---|
public abstract void setYearlyType (int type)
Set the type of day that will be used as this trigger day
Parameters
| type | int type of day. Either
TypeDayNumeric or
TypeDayOfWeek
|
|---|