Package com.microstrategy.web.objects
Interface WebShortcutNode
-
- All Superinterfaces:
WebNode
,WebPromptableNode
,WebPromptSite
- All Known Subinterfaces:
WebGridUnitShortcutNode
,WebRefNode
- All Known Implementing Classes:
WebGridUnitShortcutNodeImpl
public interface WebShortcutNode extends WebPromptableNode
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 theWebNode
interface, which this one extends.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebObjectInfo
getDataSetObj()
Returns the data set object a metric belongs to.WebObjectInfo
getTarget()
Returns the object which the shortcut refers to.void
setDataSetObj(WebObjectInfo objectInfo)
Sets the data set object a metric belongs to.void
setTarget(WebObjectInfo objectInfo)
Sets the object which the shortcut refers to.-
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.WebPromptableNode
containsNonSystemPrompts
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
Method Detail
-
getTarget
WebObjectInfo getTarget()
Returns the object which the shortcut refers to.- Returns:
- A
WebObjectInfo
object which describes the object which the shortcut node refers to. - See Also:
setTarget(com.microstrategy.web.objects.WebObjectInfo)
-
setTarget
void setTarget(WebObjectInfo objectInfo) throws java.lang.IllegalArgumentException
Sets the object which the shortcut refers to.- Parameters:
objectInfo
- AWebObjectInfo
object which describes the object which the shortcut node will refer to.- Throws:
java.lang.IllegalArgumentException
- Thrown if the given target is null.- See Also:
getTarget()
-
getDataSetObj
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:
- A
WebObjectInfo
a data set object. - Since:
- MicroStrategy Web 9.0.0
-
setDataSetObj
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
- AWebObjectInfo
a data set object.- Since:
- MicroStrategy Web 9.0.0
-
-