Package com.microstrategy.web.objects
Interface WebLinkItems
-
- All Superinterfaces:
EditableObject
public interface WebLinkItems extends EditableObject
Represents a collection of individualWebLinkItem
objects.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebLinkItem
add(WebObjectInfo[] keys)
adds a newWebLinkItem
object to this collection.void
clear()
Resets the collection to be empty.boolean
containsItem(WebObjectInfo[] keys)
java.util.Enumeration
elements()
WebLinkItems
filter(java.util.List<WebObjectInfo[]> keysList)
Filter the link items with keys list.WebLinkItem
get(int index)
retrives theWebLinkItem
from this collection based on the indexWebLinkItem
get(WebObjectInfo[] keys)
retrieves theWebLinkItem
based on the specific key.boolean
isEmpty()
Indicates whether the collection has anyWebLinkItem
objectsvoid
load()
loads all theWebLinkItem
objects into this collection If there are items already existing in the collection, then the new items are just added.void
load(WebObjectInfo[] keys)
loads all theWebLinkItem
objects into this collection for specific key If there are items already existing in the collection, then the new items are just added.void
remove(int index)
remove aWebLinkItem
at the specific indexvoid
remove(WebObjectInfo[] keys)
int
size()
Returns the size of the collection-
Methods inherited from interface com.microstrategy.web.objects.EditableObject
delete, save, save
-
-
-
-
Method Detail
-
add
WebLinkItem add(WebObjectInfo[] keys)
adds a newWebLinkItem
object to this collection. If the keys specified in created this item match with an existing item, then only the properties that are explicitly written to will be saved, the others will still use default values- Parameters:
keys
- array withWebObjectInfo
objects corresponding to the types that go into forming that link that this object is a part of- Returns:
- the newly added
WebLinkItem
-
get
WebLinkItem get(int index) throws java.lang.IndexOutOfBoundsException
retrives theWebLinkItem
from this collection based on the index- Parameters:
index
- valid values are from 0 to size()-1- Returns:
- the
WebLinkItem
from this collection based on the index - Throws:
java.lang.IndexOutOfBoundsException
- if the specified index is out of bounds
-
containsItem
boolean containsItem(WebObjectInfo[] keys)
- Parameters:
keys
- array withWebObjectInfo
objects corresponding to the types that go into forming that link that this object is a part of.- Returns:
- boolean indicating whether the item identified by the keys exists in the collection
-
get
WebLinkItem get(WebObjectInfo[] keys) throws WebObjectsException
retrieves theWebLinkItem
based on the specific key. Returns null if this item does not exist in the collection.- Parameters:
keys
- array withWebObjectInfo
objects corresponding to the types that go into forming that link that this object is a part of.- Returns:
- the
WebLinkItem
based on the specific key - Throws:
WebObjectsException
-
remove
void remove(int index) throws java.lang.IndexOutOfBoundsException
remove aWebLinkItem
at the specific index- Parameters:
index
- valid values are from 0 to size()-1- Throws:
java.lang.IndexOutOfBoundsException
-
clear
void clear()
Resets the collection to be empty.
-
isEmpty
boolean isEmpty()
Indicates whether the collection has anyWebLinkItem
objects- Returns:
- boolean indicating whether the collection has any
WebLinkItem
objects
-
size
int size()
Returns the size of the collection- Returns:
- the size of the collection
-
elements
java.util.Enumeration elements()
- Returns:
- and Enumeration of the
WebLinkItem
objects
-
load
void load() throws WebObjectsException
loads all theWebLinkItem
objects into this collection If there are items already existing in the collection, then the new items are just added. The existing items are not overwritten- Throws:
WebObjectsException
- if there an error reading the items from the metadata
-
load
void load(WebObjectInfo[] keys) throws WebObjectsException
loads all theWebLinkItem
objects into this collection for specific key If there are items already existing in the collection, then the new items are just added. The existing items are not overwritten- Parameters:
keys
- array withWebObjectInfo
objects corresponding to the types that go into forming that link that this object is a part of- Throws:
WebObjectsException
-
remove
void remove(WebObjectInfo[] keys) throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
filter
WebLinkItems filter(java.util.List<WebObjectInfo[]> keysList)
Filter the link items with keys list. It will filter the link items in memory without save to metadata. If keys are full formatted, it will filter items with every key provided. If duplicated keys are provided, only one link item will be filtered.- Parameters:
keysList
- You can choose to provide the full format of keys or partial of keys.- Returns:
-
-