Package com.microstrategy.web.objects

Interface WebGridUnitShortcutNode

All Superinterfaces:

WebNode, WebPromptableNode, WebPromptSite, WebShortcutNode

All Known Implementing Classes:

WebGridUnitShortcutNodeImpl

public interface WebGridUnitShortcutNode
extends WebShortcutNode

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

Method Summary

Modifier and Type	Method	Description
WebAttributeForm	getFormInfo()	return the attribute form which the shortcut node refers to.
java.lang.String	getNodeKey()	Return the nodeKey
WebObjectInfo	getTarget()	return the object which the shortcut refers to
void	setFormInfo(WebAttributeForm formInfo)	set the attribute form which the shortcut node refers to.
void	setNodeKey(java.lang.String nodeKey)	Set the nodeKey
void	setTarget(WebObjectInfo objectInfo)	set the grid unit which the shortcut node 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.WebPromptSite

getPromptInstances

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

getDataSetObj, setDataSetObj

Method Detail

getNodeKey

java.lang.String getNodeKey()

Return the nodeKey

Returns:

{String} nodeKey

setNodeKey

void setNodeKey(java.lang.String nodeKey)

Set the nodeKey

Parameters:

nodeKey -

getTarget

WebObjectInfo getTarget()

return the object which the shortcut refers to

Specified by:

getTarget in interface WebShortcutNode

Returns:

A WebObjectInfo object which describes the grid unit which the shortcut node refers to.

See Also:

WebShortcutNode.setTarget(com.microstrategy.web.objects.WebObjectInfo)

setTarget

void setTarget(WebObjectInfo objectInfo)
        throws java.lang.IllegalArgumentException

set the grid unit which the shortcut node refers to

Specified by:

setTarget in interface WebShortcutNode

Parameters:

objectInfo - A WebObjectInfo object which describes the grid unit which the shortcut node refers to.

Throws:

java.lang.IllegalArgumentException - Thrown if the argument is null.

See Also:

WebShortcutNode.getTarget()

getFormInfo

WebAttributeForm getFormInfo()

return the attribute form which the shortcut node refers to.

Returns:

A WebAttributeForm object which describes the attribute form which the shortcut node refers to.

setFormInfo

void setFormInfo(WebAttributeForm formInfo)
          throws java.lang.IllegalArgumentException

set the attribute form which the shortcut node refers to.

Parameters:

formInfo - A WebAttributeForm object which describes the attribute form which the shortcut node will refer to.

Throws:

java.lang.IllegalArgumentException - Thrown if the argument is null.