com.ibm.commerce.pa.widget.beans
Class ListDataBean
java.lang.Object
|
+--com.ibm.commerce.pa.beans.DynamicDataBeanImpl
|
+--com.ibm.commerce.pa.widget.beans.ListDataBean
- All Implemented Interfaces:
- CommandDataBean, DataBean, DynamicDataBean, InputDataBean, java.io.Serializable
- Direct Known Subclasses:
- SortByColumnDataBean
- public class ListDataBean
- extends DynamicDataBeanImpl
- See Also:
- Serialized Form
Field Summary |
protected java.util.Vector |
list
|
Fields inherited from class com.ibm.commerce.pa.beans.DynamicDataBeanImpl |
constraintList, COPYRIGHT, defaultWidget, errorCode, errorMessage, interfaceName, metaData, pageName, parent, parentName, requestProperties, scriptName |
Constructor Summary |
ListDataBean()
ListDataBean constructor. |
Method Summary |
void |
addElement(ElementDataBean ds)
Add a new element to the list. |
void |
copy(DynamicDataBean ds)
Copy a databean into this databean. |
ElementDataBean |
getElementAt(int n)
This method returns the Element databean at element n |
DsData[] |
getElements()
Get the collection of data objects in the list. |
ElementDataBean |
getItem(java.lang.String itemName)
This method will return an element given the name. |
java.util.Enumeration |
getItems()
This method returns the elements in the list as an enumeration. |
java.util.Vector |
getList()
Get the collection of elements in the list. |
int |
getSize()
This method returns the number of elements in the list. |
void |
insertElementAt(ElementDataBean ds,
int index)
This method will insert an element into the list at the position
supplied. |
protected void |
setList(java.util.Vector newValue)
This method sets the collection of elements in the list. |
Methods inherited from class com.ibm.commerce.pa.beans.DynamicDataBeanImpl |
addConstraint, getCommandInterfaceName, getConstraintList, getDefaultWidget, getErrorCode, getErrorMessage, getMetaData, getPageName, getParent, getParentName, getRequestProperties, getScriptName, setCommandInterfaceName, setConstraintList, setDefaultWidget, setErrorCode, setErrorMessage, setMetaData, setPageName, setParent, setParentName, setRequestProperties, setScriptName |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
list
protected java.util.Vector list
ListDataBean
public ListDataBean()
- ListDataBean constructor.
addElement
public void addElement(ElementDataBean ds)
- Add a new element to the list.
- Parameters:
ds
- The databean to add to the list.
copy
public void copy(DynamicDataBean ds)
- Copy a databean into this databean. The databean supplied must
be a ListDataBean.
- Overrides:
copy
in class DynamicDataBeanImpl
- Parameters:
ds
- The databean to copy.
getElementAt
public ElementDataBean getElementAt(int n)
- This method returns the Element databean at element n
- Parameters:
n
- The location in the list of the element to retrieve.- Returns:
- The databean for the element.
getElements
public DsData[] getElements()
- Get the collection of data objects in the list. Each element
in the list contains a DsData object. This method gets the
data object from each element databean and puts it into
the collection to be returned.
- Returns:
- The collection of data objects.
getItem
public ElementDataBean getItem(java.lang.String itemName)
- This method will return an element given the name.
The name is in the element databean's metadata.
- Parameters:
itemName
- The name of the element to retrieve.- Returns:
- The element databean with the supplied name, or null if not found.
getItems
public java.util.Enumeration getItems()
- This method returns the elements in the list as an enumeration.
- Returns:
- The elements in the list as an enumeration.
getList
public java.util.Vector getList()
- Get the collection of elements in the list.
- Returns:
- The list of elements.
getSize
public int getSize()
- This method returns the number of elements in the list.
- Returns:
- The number of elements.
insertElementAt
public void insertElementAt(ElementDataBean ds,
int index)
- This method will insert an element into the list at the position
supplied.
- Parameters:
ds
- The element to insert.index
- The position in the list where the element should be inserted.
setList
protected void setList(java.util.Vector newValue)
- This method sets the collection of elements in the list.
- Parameters:
newValue
- The list of elements.