Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract WebCertifiedInfo	getCertifiedInfo()
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp() Get the object modification timestamp in millisecond.
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

From interface com.microstrategy.web.objects.WebScheduleTrigger

From interface com.microstrategy.web.objects.WebScheduleTriggerTime

abstract void	disableTriggerRepeat() Prevents the trigger from firing multiple times on a trigger day
abstract void	enableTriggerRepeat(int type, int value) This method is deprecated. use `enableTriggerRepeat(int)`
abstract void	enableTriggerRepeat(int value) Enables the trigger to fire multiple times on the trigger day
abstract int	getMinutesAfterMidnight() This method is deprecated. use `getRepeatStart()`
abstract int	getRepeatStart() Returns the number of seconds after midnight that this trigger will begin repeat firing.
abstract int	getRepeatStop() Returns the number of seconds after midnight that this trigger will end repeat firing.
abstract int	getRepeatValue() Returns the number of minutes between same day firings
abstract int	getRepeatValueType() This method is deprecated. This interface only supports `TypeMinute` as of 2009.05.07
abstract int	getTriggerSubType() Returns the subtype of a time trigger
abstract String	getTriggerTime() Returns text specifying the 24-hour time that the trigger will fire once.
abstract boolean	isTriggerRepeatable() Returns whether this trigger will fire repeatedly throughout the trigger day
abstract void	setMinutesAfterMidnight(int minutes) This method is deprecated. use `setRepeatStart(int)`
abstract void	setRepeatStart(int seconds) Sets the number of seconds after midnight that the trigger will begin repeat firing.
abstract void	setRepeatStop(int seconds) Sets the number of seconds after midnight that this trigger will end repeat firing.
abstract void	setTriggerTime(String time) Sets the time at which the trigger will fire once.

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

int value from EnumDSSXMLDayOfWeekBitEncoded

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

int value. See TypeDayNumeric, TypeDayOfWeek

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

int number of weeks after beginning of month that trigger will fire. See: firstWeek, secondWeek, thirdWeek, fourthWeek, lastWeek

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`

Interfaces

Classes

Enums

Exceptions

WebScheduleTriggerTimeMonthly

Summary

Constants

public static final int firstWeek

public static final int fourthWeek

public static final int lastWeek

public static final int secondWeek

public static final int thirdWeek

Public Methods

public abstract int getDate ()

Returns

public abstract int getDayOfWeek ()

Returns

public abstract int getMonthlyRepeatValue ()

Returns

public abstract int getMonthlyType ()

Returns

public abstract int getWeekOffset ()

Returns

public abstract void setDate (int date)

Parameters

public abstract void setDayOfWeek (int day)

Parameters

public abstract void setMonthlyRepeatValue (int value)

Parameters

public abstract void setMonthlyType (int type)

Parameters

public abstract void setWeekOffset (int offset)

Parameters