Package com.microstrategy.web.transform

Interface LayoutSourceDefns

All Superinterfaces:

java.lang.Cloneable, ConfigurationElement

All Known Implementing Classes:

LayoutSourceDefnsImpl

public interface LayoutSourceDefns
extends ConfigurationElement

The LayoutSourceDefns interface represents a collection of layout source defined by this Style Catalog.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the collection of layout source definition objects.
int	getCount()	Returns the number of LayoutSourceDefn objects in this collection.
LayoutSourceDefn	getLayoutSourceDefn(int index)	Gets the LayoutSourceDefn associated with supplied index.
LayoutSourceDefn	getLayoutSourceDefn(java.lang.String name)	Gets the LayoutSourceDefn associated with a given name.
LayoutSourceDefn	newLayoutSourceDefn(java.lang.String layoutSourceName)	Creates a new layout source definition object with the supplied name.
void	remove(int index)	Removes the LayoutSourceDefn object at the specified index.
void	remove(java.lang.String name)	Removes the LayoutSourceDefn object at the specified index.

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Method Detail

getCount

int getCount()

Returns the number of LayoutSourceDefn objects in this collection.

Returns:

The count of layout source definition objects.

getLayoutSourceDefn

LayoutSourceDefn getLayoutSourceDefn(int index)
                              throws java.lang.IndexOutOfBoundsException

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 LayoutSourceDefn at the supplied index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

getLayoutSourceDefn

LayoutSourceDefn getLayoutSourceDefn(java.lang.String name)
                              throws java.lang.IllegalArgumentException

Gets the LayoutSourceDefn associated with a given name.

Parameters:

name - The name of the layout source definition object to return.

Returns:

The LayoutSourceDefn object with the supplied name.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the argument does not match one of the stored names.

clear

void clear()
    throws java.lang.UnsupportedOperationException

Clears the collection of layout source definition objects.

Throws:

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

remove

void remove(int index)
     throws java.lang.IndexOutOfBoundsException,
            java.lang.UnsupportedOperationException

Removes the LayoutSourceDefn object at the specified index.

Parameters:

index - The index of the layout source definition object to remove.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

remove

void remove(java.lang.String name)
     throws java.lang.IllegalArgumentException,
            java.lang.UnsupportedOperationException

Removes the LayoutSourceDefn object at the specified index.

Parameters:

name - The name of the layout source definition object to remove.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the argument does not match one of the stored names.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

newLayoutSourceDefn

LayoutSourceDefn newLayoutSourceDefn(java.lang.String layoutSourceName)
                              throws java.lang.IllegalArgumentException,
                                     java.lang.UnsupportedOperationException

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:

java.lang.IllegalArgumentException - This exception is thrown if the argument already matches one of the stored names.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.