public interface

WebDerivedElements

com.microstrategy.web.objects.WebDerivedElements
Known Indirect Subclasses

Class Overview

This interface represents a collection of Derived Elements

Summary

Public Methods
abstract void add(WebDerivedElement de, int position)
Adds derived element to the collection
abstract void clear()
Removes all Derived Elements from the collection.
abstract boolean contains(String id)
Returns true if the Derived Element with the given id exists in the collection.
abstract Enumeration elements()
Returns a java.util.Enumeration which can be used to iterate through the list of elements in the collection.
abstract WebDerivedElement get(int index)
Returns the Derived Element object with the given index.
abstract WebDerivedElement get(String id)
Returns a Derived Element object with the given id, if it exists.
abstract WebExpression getDomainExpression()
abstract int getInsertPosition()
abstract String getLinkedObjectName()
abstract boolean hasVisibleList()
abstract int indexOf(String id)
Finds the index of Derived Element with the given id.
abstract boolean isEditable()
abstract boolean isLinked()
abstract boolean isSort()
abstract void moveTo(String id, int position)
Moves spesified Derived Element to specify position
abstract WebDerivedElement remove(int index)
Removes a derived element located in the index position.
abstract WebDerivedElement remove(String id)
Removes the Derived Element object with the given id from the collection;
abstract int size()
Returns the number of elements currently in the collection.

Public Methods

public abstract void add (WebDerivedElement de, int position)

Adds derived element to the collection

Parameters
de element
position position
Throws
IllegalArgumentException Thrown if the element already exists in the collection.
IndexOutOfBoundsException Thrown if the position is out of bondories.

public abstract void clear ()

Removes all Derived Elements from the collection.

public abstract boolean contains (String id)

Returns true if the Derived Element with the given id exists in the collection.

Parameters
id The Derived Element ID.
Returns
  • Whether the element with the given id exists in the collection.

public abstract Enumeration elements ()

Returns a java.util.Enumeration which can be used to iterate through the list of elements in the collection.

Returns
  • An Enumeration which allows iteration through the collection.

public abstract WebDerivedElement get (int index)

Returns the Derived Element object with the given index.

Parameters
index The index of the element in the collection.
Returns
  • The Derived Element object corresponding to the given index in the collection.
Throws
IndexOutOfBoundsException Thrown if the given index is out of the bounds of the collection.

public abstract WebDerivedElement get (String id)

Returns a Derived Element object with the given id, if it exists.

Parameters
id The key of the element to search for in the collection.
Returns
  • A Derived Element object in the collection corresponding to the given key.
Throws
IllegalArgumentException Thrown if the element with the given id does not exist in the collection.

public abstract WebExpression getDomainExpression ()

public abstract int getInsertPosition ()

public abstract String getLinkedObjectName ()

public abstract boolean hasVisibleList ()

public abstract int indexOf (String id)

Finds the index of Derived Element with the given id.

Parameters
id String
Returns
  • index or -1 if element not found.

public abstract boolean isEditable ()

public abstract boolean isLinked ()

public abstract boolean isSort ()

public abstract void moveTo (String id, int position)

Moves spesified Derived Element to specify position

Parameters
id element ID
position new position
Throws
IllegalArgumentException Thrown if the element not found.
IndexOutOfBoundsException Thrown if the position is out of bondories.

public abstract WebDerivedElement remove (int index)

Removes a derived element located in the index position.

Parameters
index position
Returns
  • Removed derived element
Throws
IndexOutOfBoundsException if index is out of bounds

public abstract WebDerivedElement remove (String id)

Removes the Derived Element object with the given id from the collection;

Parameters
id The element id.

public abstract int size ()

Returns the number of elements currently in the collection.

Returns
  • The current number of elements in the collection.