Package com.microstrategy.web.objects

Interface WebShortcut

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

All Known Implementing Classes:

WebDossierPersonalViewShortcutImpl

public interface WebShortcut
extends WebObjectInfo

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 EnumDSSXMLObjectTypes.DssXmlTypeShortcut. Shortcut object can be obtained from WebObjectSource. When it is retrieved through the WebObjectSource, the flags for dependent (for example, EnumDSSXMLObjectFlags.DssXmlObjectDepnDefn, EnumDSSXMLObjectFlags.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 EnumDSSXMLObjectFlags.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 EnumDSSXMLSearchFlags.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.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
WebObjectInfo	getTarget()	Returns the object referenced by this shortcut.
void	setTarget(WebObjectInfo target)	Sets the object referenced by this shortcut.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

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

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

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

isFeatureAvailable, isFeatureAvailable

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

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

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

getPromptInstances

Method Detail

getTarget

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.

setTarget

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

Sets the object referenced by this shortcut.

Parameters:

target - WebObjectInfo The target object referenced by this shortcut.

Throws:

java.lang.IllegalArgumentException - Thrown when the input target is null or is of shortcut type, which is not allowed.