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
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
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

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.