Summary: Methods | Inherited Methods | [Expand All]

public interface

WebScheduleTrigger

implements WebObjectInfo

com.microstrategy.web.objects.WebScheduleTrigger

Known Indirect Subclasses

WebScheduleTriggerEvent, WebScheduleTriggerTime, WebScheduleTriggerTimeDaily, WebScheduleTriggerTimeMonthly, WebScheduleTriggerTimeWeekly, WebScheduleTriggerTimeYearly

Class Overview

WebScheduleTrigger represents a trigger on the Intelligence Server. This trigger object can be time-based or event-based.

Summary

Public Methods
abstract String	getStartDate() Returns the date after which this trigger will be active
abstract String	getStopDate() Returns the date after which this trigger will be inactive.
abstract int	getTriggerType() Returns the type of Trigger this is
abstract boolean	isStopDateSet() Returns whether the stop date is set for this trigger
abstract void	setStartDate(String date) Sets the date after which this trigger will be active
abstract void	setStopDate(String date) Sets the date after which this trigger will no longer fire.
abstract WebScheduleTriggerTimeDaily	setToDaily() Return this trigger object as Daily Trigger.
abstract WebScheduleTriggerEvent	setToEvent() Return this trigger object as Event Trigger.
abstract WebScheduleTriggerTimeMonthly	setToMonthly() Return this trigger object as Monthly Trigger.
abstract WebScheduleTriggerTimeWeekly	setToWeekly() Return this trigger object as Weekly Trigger.
abstract WebScheduleTriggerTimeYearly	setToYearly() Return this trigger object as Yearly Trigger.

[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 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 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()
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	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 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() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
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	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract String getStartDate ()

Returns the date after which this trigger will be active

Returns

String containing mm/dd/yyyy formatted date

public abstract String getStopDate ()

Returns the date after which this trigger will be inactive. Only meaningful if stop date is set. Use isStopDateSet() to verify that stop date is set

Returns

String containing mm/dd/yyyy formatted date

public abstract int getTriggerType ()

Returns the type of Trigger this is

Returns

int value from EnumDSSXMLScheduleTriggerType

public abstract boolean isStopDateSet ()

Returns whether the stop date is set for this trigger

Returns

boolean value stating whether the stop date is set for this trigger

public abstract void setStartDate (String date)

Sets the date after which this trigger will be active

Parameters

date	String containing mm/dd/yy or mm/dd/yyyy formatted date. Empty or null string will result in no stop date for this trigger

public abstract void setStopDate (String date)

Sets the date after which this trigger will no longer fire.

Parameters

date	String containing mm/dd/yy or mm/dd/yyyy formatted date. Empty or null string will result in no stop date for this trigger

public abstract WebScheduleTriggerTimeDaily setToDaily ()

Return this trigger object as Daily Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

WebScheduleTriggerTimeDaily version of this trigger

public abstract WebScheduleTriggerEvent setToEvent ()

Return this trigger object as Event Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

WebScheduleTriggerEvent version of this trigger

public abstract WebScheduleTriggerTimeMonthly setToMonthly ()

Return this trigger object as Monthly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

WebScheduleTriggerTimeMonthly version of this trigger

public abstract WebScheduleTriggerTimeWeekly setToWeekly ()

Return this trigger object as Weekly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

WebScheduleTriggerTimeWeekly version of this trigger

public abstract WebScheduleTriggerTimeYearly setToYearly ()

Return this trigger object as Yearly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger

Returns

WebScheduleTriggerTimeYearly version of this trigger

Interfaces

Classes

Enums

Exceptions

WebScheduleTrigger

Class Overview

Summary

Public Methods

public abstract String getStartDate ()

Returns

public abstract String getStopDate ()

Returns

public abstract int getTriggerType ()

Returns

public abstract boolean isStopDateSet ()

Returns

public abstract void setStartDate (String date)

Parameters

public abstract void setStopDate (String date)

Parameters

public abstract WebScheduleTriggerTimeDaily setToDaily ()

Returns

public abstract WebScheduleTriggerEvent setToEvent ()

Returns

public abstract WebScheduleTriggerTimeMonthly setToMonthly ()

Returns

public abstract WebScheduleTriggerTimeWeekly setToWeekly ()

Returns

public abstract WebScheduleTriggerTimeYearly setToYearly ()

Returns