public interface

WebOperatorNode

implements WebPromptableNode
com.microstrategy.web.objects.WebOperatorNode

Class Overview

The WebOperatorNode interface represents an operator node within an expression. This interface contains methods specific to an operator node. For methods which apply to all nodes, see the WebNode interface, which this one extends.

Summary

Public Methods
abstract int getFunction()
Returns the function being used in the node.
abstract int getFunctionType()
Returns the function type of the node.
abstract String getPropertyString()
Returns an XML string representing the properties of this operator node.
abstract void setFunction(int function)
Sets the function being used in the operator node.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebNode
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract int getFunction ()

Returns the function being used in the node.

Returns
See Also

public abstract int getFunctionType ()

Returns the function type of the node.

Returns

public abstract String getPropertyString ()

Returns an XML string representing the properties of this operator node. This string is empty for operator whose function is NOT (@link EnumDSSXMLFunction#DssXmlFunctionRank}. When its function is (@link EnumDSSXMLFunction#DssXmlFunctionRank}, these properties will be used to carry more information about this operator. Basically there are two properties, one of index 4, one of index 5. The index 5 property will determine whether this operator is really a Rank operator or a Percentage operator. If this string contains "", then it is a Percentage operator. The index 4 property can determine the actual function, for example whether it is TOP function or a BOTTOM function.

Returns
  • The XML string of properties.

public abstract void setFunction (int function)

Sets the function being used in the operator node.

Parameters
function The function to use, from EnumDSSXMLFunction( or EnumWebMRPFunction in the case of rank or percent nodes).
Throws
IllegalArgumentException Thrown if the function passed is invalid.
See Also