Package com.microstrategy.web.app.beans
Interface GUIOperator
-
public interface GUIOperator
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDisplayName()
Returns the display name of this operator.int
getDSSFunction()
Returns the dss function value of this operator.int
getFunctionType()
Returns the function type of this operator.int
getWebFunction()
Returns the web function value of this operator Web function value.boolean
isAscending()
Returns whether current operator is for ascending.void
setAscending(boolean val)
Sets whether current operator is ascending.void
setDisplayName(java.lang.String disp)
Sets display name for this operator.void
setDSSFunction(int dssFunc)
Sets the dss function value of this operatorvoid
setFunctionType(int funcType)
Sets the function type of this operator.void
setWebFunction(int func)
Sets web function value of this operator.
-
-
-
Method Detail
-
getDSSFunction
int getDSSFunction()
Returns the dss function value of this operator. This function value has to be considered with function type and ascending/descending information to fully describe an operator.- Returns:
- operator function. An value from enumeration
EnumDSSXMLFunction
- See Also:
getFunctionType()
,setFunctionType(int)
,isAscending()
,setAscending(boolean)
-
setDSSFunction
void setDSSFunction(int dssFunc)
Sets the dss function value of this operator- See Also:
getDSSFunction()
-
getWebFunction
int getWebFunction()
Returns the web function value of this operator Web function value. This value with function type, can fully describe the operator. This is the value mostly used in web application. It is a value from two enumerations. When the function type is GenericEnumWebFunctionType.WebFunctionTypeGeneric
, the value is the same as DSS function valuegetDSSFunction()
. When the function type is RankEnumWebFunctionType.WebFunctionTypeRankQual
or PercentageEnumWebFunctionType.WebFunctionTypePercentQual
, the value is fromEnumWebMRPFunction
.- Returns:
- The web functionAn value from
EnumDSSXMLFunction
orEnumWebMRPFunction
.
-
setWebFunction
void setWebFunction(int func)
Sets web function value of this operator.- Parameters:
func
- The function to set- See Also:
getWebFunction()
-
getFunctionType
int getFunctionType()
Returns the function type of this operator.- Returns:
- the function type of this operator. An value from
EnumWebFunctionType
.
-
setFunctionType
void setFunctionType(int funcType)
Sets the function type of this operator.- Parameters:
funcType
- The function type to set.
-
isAscending
boolean isAscending()
Returns whether current operator is for ascending. This value is only meaningful when function type isEnumWebFunctionType.WebFunctionTypeRankQual
orEnumWebFunctionType.WebFunctionTypePercentQual
.- Returns:
true
if current operator is for ascending. Otherwise,false
.
-
setAscending
void setAscending(boolean val)
Sets whether current operator is ascending. This value is only meaningful when function type isEnumWebFunctionType.WebFunctionTypeRankQual
orEnumWebFunctionType.WebFunctionTypePercentQual
.- Parameters:
val
- The value to set.
-
getDisplayName
java.lang.String getDisplayName()
Returns the display name of this operator. If this operator loaded by web application, it is localized by session's locale.- Returns:
- The display name.
-
setDisplayName
void setDisplayName(java.lang.String disp)
Sets display name for this operator.- Parameters:
disp
- The name.
-
-