IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.model
Interface IListModel

All Superinterfaces:
IModel
All Known Implementing Classes:
ICollModel

public interface IListModel
extends IModel

An ordered collection (also known as a sequence). The user of this interface has precise control over where in the list each element is inserted. The user can access elements by their integer index (position in the list).


Method Summary
 void add(IModel model)
          Appends the specified element(IModel) to the end of this list.
 void add(int index, IModel model)
          Add the element(IModel) to the specified position in this list.
 void clear()
          Removes all of the elements from this list.
 IModel createChildElement(java.lang.String name)
          Create child element using the name
 IModel get(int index)
          Returns the element(IModel) at the specified position in this list.
 IModel remove(int index)
          Removes the element(IModel) at the specified position in this list.
 void set(int index, IModel model)
          Replaces the element at the specified position in this list with the specified element (optional operation).
 int size()
          Returns the number of elements in this list.
 
Methods inherited from interface com.ibm.btt.model.IModel
getContent
 

Method Detail

get

IModel get(int index)
           throws java.lang.IndexOutOfBoundsException
Returns the element(IModel) at the specified position in this list.

Parameters:
index - index of element to return.
Returns:
the element(IModel) at the specified position in this list.
Throws:
java.lang.IndexOutOfBoundsException - if index is out of range

createChildElement

IModel createChildElement(java.lang.String name)
                          throws java.lang.IllegalArgumentException
Create child element using the name

Parameters:
name - the name of the child element
Returns:
the model of the child element
Throws:
java.lang.IllegalArgumentException - when exception occurs during creating the child element

size

int size()
Returns the number of elements in this list.

Returns:
the number of elements in this list.

clear

void clear()
Removes all of the elements from this list. This list will be empty after this call returns (unless it throws an exception).


remove

IModel remove(int index)
              throws ObjectNotFoundException
Removes the element(IModel) at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters:
index - the index of the element to removed.
Returns:
the element previously at the specified position.
Throws:
ObjectNotFoundException - if the element isn't found

add

void add(IModel model)
Appends the specified element(IModel) to the end of this list.

Parameters:
model - element to be appended to this list.

add

void add(int index,
         IModel model)
Add the element(IModel) to the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:
index - the index of the element to added
model - element to be added to this list.

set

void set(int index,
         IModel model)
Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters:
index - the index of the element to added
model - element to be added to this list.

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011