Package com.microstrategy.web.objects

Interface WebLimitExpressionHelper

All Superinterfaces:

WebExpressionHelper

All Known Implementing Classes:

RWViewLimitHelper, WebMDXReportLimitHelper, WebSubsetViewLimitHelper

public interface WebLimitExpressionHelper
extends WebExpressionHelper

A subclass of the WebExpressionHelper that provides special functionality for editing limit expressions.

Since:

MicroStrategy Web 9.0.1

Method Summary

Modifier and Type	Method	Description
void	addUnitLimit(WebNode node)
WebNode	findUnitNode(java.lang.String unitId)	Finds a root node of the unit limit expression
java.lang.String	getNodeGroupId(WebNode node)	Returns limit group ID of the given node
int	getNodeLimitType(WebNode node)	Returns limit type EnumWebLimitSummaryFlags of the given node
java.lang.String	getNodeUnitId(WebNode node)	Returns unit ID of the given node
WebNode	getUnitNode(WebNode node)	Gets a root node of the unit limit expression for a given expression node
boolean	hasUnussignedPrompts(WebNode node)	Returns true if the given node contains unresolved prompts.
void	removeLimits()
void	removeUnitLimit(java.lang.String unitId)
void	replaceUnitLimit(WebNode node)

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

canEditExpression, canGroup, canGroup, canSwapWithNext, canSwapWithNext, canSwapWithPrevious, canSwapWithPrevious, canUngroup, canUngroup, compareTo, consolidateTree, delete, delete, getAutoConsolidation, getNewRootNode, group, group, hasFilterOn, isEqual, removeEmptyFilters, setAutoConsolidation, swap, swap, swapWithNext, swapWithNext, swapWithPrevious, swapWithPrevious, toggleFunction, toggleFunction, ungroup, ungroup, validateOperands

Method Detail

addUnitLimit

void addUnitLimit(WebNode node)
           throws WebObjectsException

Throws:

WebObjectsException

replaceUnitLimit

void replaceUnitLimit(WebNode node)

removeUnitLimit

void removeUnitLimit(java.lang.String unitId)

removeLimits

void removeLimits()

getUnitNode

WebNode getUnitNode(WebNode node)

Gets a root node of the unit limit expression for a given expression node

Parameters:

node - expression node

Returns:

node

findUnitNode

WebNode findUnitNode(java.lang.String unitId)

Finds a root node of the unit limit expression

Parameters:

unitId - an ID of the working set unit

Returns:

node or null

getNodeUnitId

java.lang.String getNodeUnitId(WebNode node)

Returns unit ID of the given node

Parameters:

node - node

Returns:

unit ID

getNodeGroupId

java.lang.String getNodeGroupId(WebNode node)

Returns limit group ID of the given node

Parameters:

node - node

Returns:

group ID

getNodeLimitType

int getNodeLimitType(WebNode node)

Returns limit type EnumWebLimitSummaryFlags of the given node

Parameters:

node - node

Returns:

limit type

hasUnussignedPrompts

boolean hasUnussignedPrompts(WebNode node)

Returns true if the given node contains unresolved prompts. In this case we don't know what unit to ussign this limit to.

Parameters:

node -