Package com.microstrategy.web.objects

Interface WebRelationshipNode

All Superinterfaces:

WebNode, WebPromptableNode, WebPromptSite

public interface WebRelationshipNode
extends WebPromptableNode

The WebRelationshipNode interface represents a relationship node within an expression. A relationship node is a qualification which allows the user to filter a certain attribute by it's relationship to other attributes. Also worth noting is that a relationship node, like an operator node, can have child nodes. This interface contains methods specific to a relationship node. For methods which apply to all nodes, see the WebNode interface, which this one extends.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
boolean	getApplySubExpression()	Returns the applySubExpression flag.
WebRelationship	getRelationship()	Returns the object describing the relationship which defines the relationship node.
boolean	getUseSchema()	Returns the useSchema flag.
void	setApplySubExpression(boolean applySubExpression)	Sets the applySubExpression flag.
void	setRelationship(WebRelationship relationship)	Sets the object describing the relationship which defines the relationship node.
void	setUseSchema(boolean useSchema)	Sets the useSchema flag.

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

appendChild, clear, clearPlaceHolder, containsPrompts, createPlaceHolder, getCanExpand, getChild, getChildCount, getDataType, getDimensionality, getDimensionalityType, getDisplayName, getExpressionType, getFirstChild, getIsIndependentCSI, getIsSpliced, getKey, getLastChild, getNextSibling, getNodeType, getParent, getPlaceHolder, getPreviousSibling, getShortXML, getTag, getUCFlag, hasChildNodes, hasPlaceHolder, insertAfter, insertBefore, isCancelledPrompt, removeChild, replaceChild, setCanExpand, setDataType, setDimensionalityType, setDisplayName, setExpressionType, setIsIndependentCSI, setIsSpliced, setTag, setUCFlag

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

getPromptInstances

Method Detail

getApplySubExpression

boolean getApplySubExpression()

Returns the applySubExpression flag.

Under normal use in a filter, the subexpression below the relationship node is converted to a different filter by applying the relationship on this node. The expression is not used, other than as a source for the relationship. Setting this property to True asks that the sub-expression is applied in its own right as well.

Returns:

The current value of the applySubExpression flag.

See Also:

setApplySubExpression(boolean)

setApplySubExpression

void setApplySubExpression(boolean applySubExpression)

Sets the applySubExpression flag.

Under normal use in a filter, the subexpression below the relationship node is converted to a different filter by applying the relationship on this node. The expression is not used, other than as a source for the relationship. Setting this property to True asks that the sub-expression is applied in its own right as well.

Parameters:

applySubExpression - The desired value of the applySubExpression flag.

See Also:

getApplySubExpression()

getUseSchema

boolean getUseSchema()

Returns the useSchema flag. If this is true, then the relationship object will be ignored, and instead, the schema will be used to determine the relationship used in the relationship node.

Returns:

The current value of the useSchema flag.

See Also:

setUseSchema(boolean)

setUseSchema

void setUseSchema(boolean useSchema)

Sets the useSchema flag. If this is true, then the relationship object will be ignored and instead, the schema will be used to determine the relationship used in the relationship node.

Parameters:

useSchema - The desired value of the useSchema flag.

See Also:

getUseSchema()

getRelationship

WebRelationship getRelationship()

Returns the object describing the relationship which defines the relationship node.

Returns:

A WebRelationship object, corresponding to the relationship set on the node.

setRelationship

void setRelationship(WebRelationship relationship)

Sets the object describing the relationship which defines the relationship node.

Parameters:

relationship - A WebRelationship object, corresponding to the relationship set on the node.

See Also:

getRelationship()