public interface

WebRelationshipNode

implements WebPromptableNode
com.microstrategy.web.objects.WebRelationshipNode

Class Overview

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.

Summary

Public Methods
abstract boolean getApplySubExpression()
Returns the applySubExpression flag.
abstract WebRelationship getRelationship()
Returns the object describing the relationship which defines the relationship node.
abstract boolean getUseSchema()
Returns the useSchema flag.
abstract void setApplySubExpression(boolean applySubExpression)
Sets the applySubExpression flag.
abstract void setRelationship(WebRelationship relationship)
Sets the object describing the relationship which defines the relationship node.
abstract void setUseSchema(boolean useSchema)
Sets the useSchema flag.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebNode
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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