Package com.microstrategy.web.objects

Interface WebLinkItems

All Superinterfaces:

EditableObject, java.lang.Iterable<WebLinkItem>

public interface WebLinkItems
extends EditableObject, java.lang.Iterable<WebLinkItem>

Represents a collection of individual WebLinkItem objects.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
WebLinkItem	add(WebObjectInfo[] keys)	adds a new WebLinkItem 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 the WebLinkItem from this collection based on the index
WebLinkItem	get(WebObjectInfo[] keys)	retrieves the WebLinkItem based on the specific key.
boolean	isEmpty()	Indicates whether the collection has any WebLinkItem objects
void	load()	loads all the WebLinkItem 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 the WebLinkItem 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 a WebLinkItem at the specific index
void	remove(WebObjectInfo[] keys)
int	size()	Returns the size of the collection

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

delete, save, save

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

WebLinkItem add(WebObjectInfo[] keys)

adds a new WebLinkItem 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 with WebObjectInfo 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 the WebLinkItem 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 with WebObjectInfo 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 the WebLinkItem based on the specific key. Returns null if this item does not exist in the collection.

Parameters:

keys - array with WebObjectInfo 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 a WebLinkItem 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 any WebLinkItem 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 the WebLinkItem 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 the WebLinkItem 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 with WebObjectInfo 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: