Package com.microstrategy.web.objects

Interface WebFunction

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

public interface WebFunction
extends WebObjectInfo

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

Since:

MicroStrategy Web 8.0.1

Method Summary

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

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getFunction

int getFunction()

Deprecated.

use getFunctionType() instead

Returns an integer value indicating a fuction in EnumDSSXMLFunction.

Returns:

a function value.

getFunctionType

int getFunctionType()

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

Since:

MicroStrategy Web 9.0.0

getSQLType

int getSQLType()

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

Since:

MicroStrategy Web 9.0.0

getInputParameters

java.util.Iterator getInputParameters()

Iterator of WebFunctionParameter objects

getInputParameter

WebFunctionParameter getInputParameter(int index)

Returns the WebFunctionParameter at a particular index

Parameters:

index -

Returns:

the WebFunctionParameter at a particular index

getInputParameterCount

int getInputParameterCount()

Returns the number of input parameters

Returns:

the number of input parameters

isDBOnly

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.

isPrefix

boolean isPrefix()

Indicates if the function represents a prefix operator

Returns:

true if the function represents a prefix operator.

isOrderSignificant

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.

getRepeatedParametersCount

int getRepeatedParametersCount()

Returns the number of repeated parameters.

Returns:

int the number parameters that are repeated.

Since:

MicroStrategy Web 9.0.0

getProperties

java.util.Iterator getProperties()

Returns an Iterator of all the function properties as WebFunctionProperty objects

getPropertyCount

int getPropertyCount()

Returns the total number of properties for the Function

getProperty

WebFunctionProperty getProperty(int index)

Return the Function property at the specified index.

Parameters:

index -