public interface

HighlightedObjects

com.microstrategy.web.beans.HighlightedObjects

Class Overview

This interface is a typical collection interface of HighlightedObject.

Summary

Public Methods
abstract HighlightedObject add(String objectId, int objectType)
Appends a HighlightedObject into the collection.
abstract void clear()
Removes all of the HighlightedObject from the collection.
abstract boolean contains(HighlightedObject ho)
Returns true if the collection contains the specified HighlightedObject
abstract HighlightedObject get(int index)
Returns the HighlightedObject at the specified position.
abstract boolean isEmpty()
Tests if this collection has no HighlightedObject
abstract void remove(int index)
Removes the HighlightedObject at the specified position from the collection
abstract boolean remove(HighlightedObject ho)
Removes the specified HighlightedObject from the collection
abstract int size()
Returns the number of HighlightedObject in this collection

Public Methods

public abstract HighlightedObject add (String objectId, int objectType)

Appends a HighlightedObject into the collection.

Parameters
objectId the object id of the HighlightedObject.
objectType the type of the HighlightedObject. It is either EnumDSSXMLObjectTypes or EnumWebDependentObjectType.
Returns
  • the HighlightedObject added.

public abstract void clear ()

Removes all of the HighlightedObject from the collection. This collection will be empty after this call returns.

public abstract boolean contains (HighlightedObject ho)

Returns true if the collection contains the specified HighlightedObject

Parameters
ho the HighlightedObject whose presence in this collection is to be tested
Returns
  • true if the collection contains the specified object

public abstract HighlightedObject get (int index)

Returns the HighlightedObject at the specified position.

Parameters
index the position of a HighlightedObject in the collection
Returns
  • the HighlightedObject at the specified position.
Throws
IndexOutOfBoundsException if the index is out of range

public abstract boolean isEmpty ()

Tests if this collection has no HighlightedObject

Returns
  • true if this colleciton has no HighlightedObject

public abstract void remove (int index)

Removes the HighlightedObject at the specified position from the collection

Parameters
index the index to the HighlightedObject to be removed
Throws
IndexOutOfBoundsException if the index is out of range

public abstract boolean remove (HighlightedObject ho)

Removes the specified HighlightedObject from the collection

Parameters
ho the HighlightedObject to be removed
Returns
  • true if the collection contains the specified HighlightedObject

public abstract int size ()

Returns the number of HighlightedObject in this collection

Returns
  • the number of HighlightedObject in this collection