public
interface
LayoutSourceDefns
implements ConfigurationElement| com.microstrategy.web.transform.LayoutSourceDefns |
 Known Indirect Subclasses
|
Class Overview
The LayoutSourceDefns interface represents a collection of layout source defined by this Style Catalog.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
clear()
Clears the collection of layout source definition objects.
| ||||||||||
| abstract int |
getCount()
Returns the number of
LayoutSourceDefn objects in this collection. | ||||||||||
| abstract LayoutSourceDefn |
getLayoutSourceDefn(int index)
Gets the
LayoutSourceDefn associated with supplied index. | ||||||||||
| abstract LayoutSourceDefn |
getLayoutSourceDefn(String name)
Gets the
LayoutSourceDefn associated with a given name. | ||||||||||
| abstract LayoutSourceDefn |
newLayoutSourceDefn(String layoutSourceName)
Creates a new layout source definition object with the supplied name.
| ||||||||||
| abstract void |
remove(int index)
Removes the
LayoutSourceDefn object at the specified index. | ||||||||||
| abstract void |
remove(String name)
Removes the
LayoutSourceDefn object at the specified index. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.config.ConfigurationElement
| |||||||||||
Public Methods
public abstract void clear ()
Clears the collection of layout source definition objects.
Throws
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
|---|
public abstract int getCount ()
Returns the number of LayoutSourceDefn objects in this collection.
Returns
- The count of layout source definition objects.
public abstract LayoutSourceDefn getLayoutSourceDefn (int index)
Gets the LayoutSourceDefn associated with supplied index. A valid
index begins at 0 and continues to getCount() - 1.
Parameters
| index | The index of the LayoutSourceDefn to return. |
|---|
Returns
- The
LayoutSourceDefnat the supplied index.
Throws
| IndexOutOfBoundsException | This exception is thown if the argument is outside the range of a valid index. |
|---|
public abstract LayoutSourceDefn getLayoutSourceDefn (String name)
Gets the LayoutSourceDefn associated with a given name.
Parameters
| name | The name of the layout source definition object to return. |
|---|
Returns
- The
LayoutSourceDefnobject with the supplied name.
Throws
| IllegalArgumentException | This exception is thrown if the argument does not match one of the stored names. |
|---|
public abstract LayoutSourceDefn newLayoutSourceDefn (String layoutSourceName)
Creates a new layout source definition object with the supplied name.
Parameters
| layoutSourceName | The name of the new LayoutSourceDefn object to create. |
|---|
Returns
- The new layout source definition object.
Throws
| IllegalArgumentException | This exception is thrown if the argument already matches one of the stored names. |
|---|---|
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
public abstract void remove (int index)
Removes the LayoutSourceDefn object at the specified index.
Parameters
| index | The index of the layout source definition object to remove. |
|---|
Throws
| IndexOutOfBoundsException | This exception is thown if the argument is outside the range of a valid index. |
|---|---|
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
public abstract void remove (String name)
Removes the LayoutSourceDefn object at the specified index.
Parameters
| name | The name of the layout source definition object to remove. |
|---|
Throws
| IllegalArgumentException | This exception is thrown if the argument does not match one of the stored names. |
|---|---|
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |