Summary: Methods | Inherited Methods | [Expand All]

public interface

WebFunction

implements WebObjectInfo

com.microstrategy.web.objects.WebFunction

Class Overview

The WebFunction interface represents a system function object. Functions are categorized into various packages

Summary

Public Methods
abstract int	getFunction() This method is deprecated. use `getFunctionType()` instead
abstract int	getFunctionType() Returns the type of the function; This is a value from the enumeration `EnumDSSXMLFunction`
abstract WebFunctionParameter	getInputParameter(int index) Returns the `WebFunctionParameter` at a particular index
abstract int	getInputParameterCount() Returns the number of input parameters
abstract Iterator	getInputParameters() Iterator of `WebFunctionParameter` objects
abstract Iterator	getProperties() Returns an Iterator of all the function properties as `WebFunctionProperty` objects
abstract WebFunctionProperty	getProperty(int index) Return the Function property at the specified index.
abstract int	getPropertyCount() Returns the total number of properties for the Function
abstract int	getRepeatedParametersCount() Returns the number of repeated parameters.
abstract int	getSQLType() Returns the SQL type of the function.This is a value from the enumeration
abstract boolean	isDBOnly() Returns true if the function is available only in the Database and not in the analytical engine.
abstract boolean	isOrderSignificant() Indicates if the function order is significant for function.
abstract boolean	isPrefix() Indicates if the function represents a prefix operator

[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

Public Methods

public abstract int getFunction ()

This method is deprecated.
use getFunctionType() instead

Returns an integer value indicating a fuction in EnumDSSXMLFunction.

Returns

a function value.

public abstract int getFunctionType ()

Returns the type of the function; This is a value from the enumeration EnumDSSXMLFunction

public abstract WebFunctionParameter getInputParameter (int index)

Returns the WebFunctionParameter at a particular index

Returns

the WebFunctionParameter at a particular index

public abstract int getInputParameterCount ()

Returns the number of input parameters

Returns

the number of input parameters

public abstract Iterator getInputParameters ()

Iterator of WebFunctionParameter objects

public abstract Iterator getProperties ()

Returns an Iterator of all the function properties as WebFunctionProperty objects

public abstract WebFunctionProperty getProperty (int index)

Return the Function property at the specified index.

public abstract int getPropertyCount ()

Returns the total number of properties for the Function

public abstract int getRepeatedParametersCount ()

Returns the number of repeated parameters.

Returns

int the number parameters that are repeated.

public abstract int getSQLType ()

Returns the SQL type of the function.This is a value from the enumeration

public abstract boolean isDBOnly ()

Returns true if the function is available only in the Database and not in the analytical engine.

Returns

true if the function is implemented in the database.

public abstract boolean isOrderSignificant ()

Indicates if the function order is significant for function. This will control whether Sort-By is available or not.

Returns

true if the order is important.

public abstract boolean isPrefix ()

Indicates if the function represents a prefix operator

Returns

true if the function represents a prefix operator.

Interfaces

Classes

Enums

Exceptions

WebFunction

Class Overview

Summary

Public Methods

public abstract int getFunction ()

Returns

public abstract int getFunctionType ()

public abstract WebFunctionParameter getInputParameter (int index)

Returns

public abstract int getInputParameterCount ()

Returns

public abstract Iterator getInputParameters ()

public abstract Iterator getProperties ()

public abstract WebFunctionProperty getProperty (int index)

public abstract int getPropertyCount ()

public abstract int getRepeatedParametersCount ()

Returns

public abstract int getSQLType ()

public abstract boolean isDBOnly ()

Returns

public abstract boolean isOrderSignificant ()

Returns

public abstract boolean isPrefix ()

Returns