public interface

BeanDefns

implements ConfigurationElement
com.microstrategy.web.transform.BeanDefns
Known Indirect Subclasses

Class Overview

The BeanDefns interface is used to manage a collection of bean definition objects.

Summary

Public Methods
abstract void clear()
Removes all of the BeanDefn objects from the collection
abstract BeanDefn getBeanDefn(String name)
Retrives a specific BeanDefn object by its name.
abstract BeanDefn getBeanDefn(int index)
Retrieves a specific BeanDefn object by its numeric index.
abstract BeanDefn getBeanDefnByClass(String className)
Retrives a specific BeanDefn object by its class name.
abstract int getCount()
Returns the number of BeanDefn objects in the collection.
abstract BeanDefn newBeanDefn(String beanName, String className)
Creates a new BeanDefn object and adds it to the collection.
abstract void remove(int index)
Removes the BeanDefn object at the specified position in the collection.
abstract void remove(String name)
Removes the BeanDefn object with the specified name from the collection.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract void clear ()

Removes all of the BeanDefn objects from the collection

Throws
UnsupportedOperationException thrown if the collection is read-only.

public abstract BeanDefn getBeanDefn (String name)

Retrives a specific BeanDefn object by its name.

Parameters
name the name of the BeanDefn object.
Returns
  • the BeanDefn object in the collection with the given name.
Throws
IllegalArgumentException thrown if no bean definition has the given name in the collection.

public abstract BeanDefn getBeanDefn (int index)

Retrieves a specific BeanDefn object by its numeric index.

Parameters
index the index of the BeanDefn object in collection.
Returns
  • the BeanDefn object in the collection with the given index.
Throws
IndexOutOfBoundsException thrown if the index is invalid.

public abstract BeanDefn getBeanDefnByClass (String className)

Retrives a specific BeanDefn object by its class name.

Parameters
className the bean class name.
Returns
  • the BeanDefn object in the collection with the given class name.
Throws
IllegalArgumentException thrown if no bean definition has the given name in the collection.

public abstract int getCount ()

Returns the number of BeanDefn objects in the collection.

Returns
  • number of BeanDefn objects contained in the collection.
See Also

public abstract BeanDefn newBeanDefn (String beanName, String className)

Creates a new BeanDefn object and adds it to the collection.

Parameters
beanName the name of the new BeanDefn object.
Returns
Throws
IllegalArgumentException thrown if the bean definition name is used by another BeanDefn object in the collection or if the style name is empty.
UnsupportedOperationException thrown if the collection is read-only.

public abstract void remove (int index)

Removes the BeanDefn object at the specified position in the collection. This method will not remove the associations made to the object deleted in a Style object.

Parameters
index the index of the BeanDefn object to remove.
Throws
thrown if the specified index is out of range.
UnsupportedOperationException thrown if the collection is read-only.
IndexOutOfBoundsException

public abstract void remove (String name)

Removes the BeanDefn object with the specified name from the collection. This method will not remove the associations made to the object deleted in a Style object.

Parameters
name the name of the BeanDefn object to remove.
Throws
IllegalArgumentException thrown if no bean definition has the given name in the collection.
UnsupportedOperationException thrown if the collection is read-only.