public interface

WebLinkItems

implements EditableObject
com.microstrategy.web.objects.WebLinkItems

Class Overview

Represents a collection of individual WebLinkItem objects.

Summary

Public Methods
abstract WebLinkItem add(WebObjectInfo[] keys)
adds a new WebLinkItem object to this collection.
abstract void clear()
Resets the collection to be empty.
abstract boolean containsItem(WebObjectInfo[] keys)
abstract Enumeration elements()
abstract WebLinkItem get(WebObjectInfo[] keys)
retrieves the WebLinkItem based on the specific key.
abstract WebLinkItem get(int index)
retrives the WebLinkItem from this collection based on the index
abstract boolean isEmpty()
Indicates whether the collection has any WebLinkItem objects
abstract 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.
abstract 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.
abstract void remove(WebObjectInfo[] keys)
abstract void remove(int index)
remove a WebLinkItem at the specific index
abstract int size()
Returns the size of the collection
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.EditableObject

Public Methods

public abstract 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

public abstract void clear ()

Resets the collection to be empty.

public abstract 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

public abstract Enumeration elements ()

Returns

public abstract WebLinkItem get (WebObjectInfo[] keys)

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
Throws
WebObjectsException

public abstract WebLinkItem get (int index)

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
IndexOutOfBoundsException if the specified index is out of bounds

public abstract boolean isEmpty ()

Indicates whether the collection has any WebLinkItem objects

Returns
  • boolean indicating whether the collection has any WebLinkItem objects

public abstract 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. The existing items are not overwritten

Throws
WebObjectsException if there an error reading the items from the metadata

public abstract 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. 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

public abstract void remove (WebObjectInfo[] keys)

Throws
WebObjectsException

public abstract void remove (int index)

remove a WebLinkItem at the specific index

Parameters
index valid values are from 0 to size()-1
Throws
IndexOutOfBoundsException

public abstract int size ()

Returns the size of the collection

Returns
  • the size of the collection