WebLink (Web API 2021)

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite
```
public interface WebLink
extends WebObjectInfo
```
This represents a link between two or more first class objects in the metadata. The class acts as a factory for specific link items
Title:

Description:

Copyright: Copyright (c) 2001

Company:

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WebLinkItems`	`getLinkItems()`
`WebLinkItems`	`getLinkItems(WebObjectInfo[] keys)`
`WebPropertyGroup`	`getLinkPropertySets()`
`WebLinkItems`	`getNewLinkItems()`	This returns an empty linkitems collection.
`SimpleList`	`getTypes()`	This method returns a read-only `SimpleList` of types that form this link

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, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

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

- Method Detail
  - getTypes
```
SimpleList getTypes()
```
    This method returns a read-only SimpleList of types that form this link
    
    Returns:
    
    a read-only list of types that are form this link
  - getLinkPropertySets
```
WebPropertyGroup getLinkPropertySets()
```
    Returns:
    
    a WebPropertyGroup with this link's property sets these set of properties are read-only
  - getNewLinkItems
```
WebLinkItems getNewLinkItems()
                      throws WebObjectsException
```
    This returns an empty linkitems collection. If the link is not populated with defn, we do it now
    
    Returns:
    
    an empty WebLinkItems collection
    
    Throws:
    
    WebObjectsException
  - getLinkItems
```
WebLinkItems getLinkItems()
                   throws WebObjectsException
```
    Returns:
    
    all the existing WebLinkItems collection associated with this link
    
    Throws:
    
    WebObjectsException
  - getLinkItems
```
WebLinkItems getLinkItems(WebObjectInfo[] keys)
                   throws WebObjectsException
```
    Parameters:
    
    keys - an array of WebObjectInfo objects corresponding to the types required for this link
    
    Returns:
    
    the WebLinkItems collection for this link filtered by the specific keys
    
    Throws:
    
    WebObjectsException