public interface

WebShortcutNode

implements WebPromptableNode
com.microstrategy.web.objects.WebShortcutNode
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract WebObjectInfo getDataSetObj()
Returns the data set object a metric belongs to.
abstract WebObjectInfo getTarget()
Returns the object which the shortcut refers to.
abstract void setDataSetObj(WebObjectInfo objectInfo)
Sets the data set object a metric belongs to.
abstract void setTarget(WebObjectInfo objectInfo)
Sets the object which the shortcut refers to.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebNode
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebObjectInfo getDataSetObj ()

Returns the data set object a metric belongs to. This property is used for shortcut nodes in the RS conditional formatting metric expressions.

Returns

public abstract WebObjectInfo getTarget ()

Returns the object which the shortcut refers to.

Returns
  • A WebObjectInfo object which describes the object which the shortcut node refers to.

public abstract void setDataSetObj (WebObjectInfo objectInfo)

Sets the data set object a metric belongs to. This property is used for shortcut nodes in the RS conditional formatting metric expressions.

Parameters
objectInfo A WebObjectInfo a data set object.

public abstract void setTarget (WebObjectInfo objectInfo)

Sets the object which the shortcut refers to.

Parameters
objectInfo A WebObjectInfo object which describes the object which the shortcut node will refer to.
Throws
IllegalArgumentException Thrown if the given target is null.
See Also