public interface

WebShortcut

implements WebObjectInfo
com.microstrategy.web.objects.WebShortcut
Known Indirect Subclasses

Class Overview

This interface represents a shortcut object, which is a first class object. It contains a reference to another first class object. NOTE: a shortcut object can not have a reference to another shortcut object. The object type of this kind of object is DssXmlTypeShortcut. Shortcut object can be obtained from WebObjectSource. When it is retrieved through the WebObjectSource, the flags for dependent (for example, DssXmlObjectDepnDefn, DssXmlObjectDepnBrowser, etc.) will be used to guide the retrieval of the referenced object. When performing folder browing and a shortcut is within the folder, the flag set to retrieve the content of the folder, will apply to the object referenced by this shortcut. For example, if DssXmlObjectDepnDates is used to populate the folder object, then not only the date information of the shortcut object in the folder will be brought back, also the referenced object, returned by getTarget() call, will include the date information also. When Performing a search, if DssXmlSearchDereferenceShortcut is set and recursive flag is set, search will dereference shortcut object. If the referenced target is folder, search will perform recursive searching into the referenced folder. This interface allows setting and getting the object referenced by this shortcut.

Summary

Public Methods
abstract WebObjectInfo getTarget()
Returns the object referenced by this shortcut.
abstract void setTarget(WebObjectInfo target)
Sets the object referenced by this shortcut.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebObjectInfo getTarget ()

Returns the object referenced by this shortcut. When the shortcut object is saved, it will not save any change made on target object itself.

Returns
  • WebObjectInfo the target object referenced by this shortcut.

public abstract void setTarget (WebObjectInfo target)

Sets the object referenced by this shortcut.

Parameters
target WebObjectInfo The target object referenced by this shortcut.
Throws
IllegalArgumentException Thrown when the input target is null or is of shortcut type, which is not allowed.