org.LexGrid.LexBIG.DataModel.Collections
Class ModuleDescriptionList

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.Collections.ModuleDescriptionList
All Implemented Interfaces:
java.io.Serializable

public class ModuleDescriptionList
extends java.lang.Object
implements java.io.Serializable

Class ModuleDescriptionList.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
ModuleDescriptionList()
           
 
Method Summary
 void addModuleDescription(int index, ModuleDescription vModuleDescription)
           
 void addModuleDescription(ModuleDescription vModuleDescription)
           
 java.util.Enumeration<? extends ModuleDescription> enumerateModuleDescription()
          Method enumerateModuleDescription.
 ModuleDescription[] getModuleDescription()
          Method getModuleDescription.Returns the contents of the collection in an Array.
 ModuleDescription getModuleDescription(int index)
          Method getModuleDescription.
 int getModuleDescriptionCount()
          Method getModuleDescriptionCount.
 java.util.Iterator<? extends ModuleDescription> iterateModuleDescription()
          Method iterateModuleDescription.
 void removeAllModuleDescription()
           
 boolean removeModuleDescription(ModuleDescription vModuleDescription)
          Method removeModuleDescription.
 ModuleDescription removeModuleDescriptionAt(int index)
          Method removeModuleDescriptionAt.
 void setModuleDescription(int index, ModuleDescription vModuleDescription)
           
 void setModuleDescription(ModuleDescription[] vModuleDescriptionArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModuleDescriptionList

public ModuleDescriptionList()
Method Detail

addModuleDescription

public void addModuleDescription(ModuleDescription vModuleDescription)
                          throws java.lang.IndexOutOfBoundsException
Parameters:
vModuleDescription -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addModuleDescription

public void addModuleDescription(int index,
                                 ModuleDescription vModuleDescription)
                          throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vModuleDescription -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateModuleDescription

public java.util.Enumeration<? extends ModuleDescription> enumerateModuleDescription()
Method enumerateModuleDescription.

Returns:
an Enumeration over all possible elements of this collection

getModuleDescription

public ModuleDescription getModuleDescription(int index)
                                       throws java.lang.IndexOutOfBoundsException
Method getModuleDescription.

Parameters:
index -
Returns:
the value of the org.LexGrid.LexBIG.DataModel.InterfaceElements.ModuleDescription at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getModuleDescription

public ModuleDescription[] getModuleDescription()
Method getModuleDescription.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getModuleDescriptionCount

public int getModuleDescriptionCount()
Method getModuleDescriptionCount.

Returns:
the size of this collection

iterateModuleDescription

public java.util.Iterator<? extends ModuleDescription> iterateModuleDescription()
Method iterateModuleDescription.

Returns:
an Iterator over all possible elements in this collection

removeAllModuleDescription

public void removeAllModuleDescription()

removeModuleDescription

public boolean removeModuleDescription(ModuleDescription vModuleDescription)
Method removeModuleDescription.

Parameters:
vModuleDescription -
Returns:
true if the object was removed from the collection.

removeModuleDescriptionAt

public ModuleDescription removeModuleDescriptionAt(int index)
Method removeModuleDescriptionAt.

Parameters:
index -
Returns:
the element removed from the collection

setModuleDescription

public void setModuleDescription(int index,
                                 ModuleDescription vModuleDescription)
                          throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vModuleDescription -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setModuleDescription

public void setModuleDescription(ModuleDescription[] vModuleDescriptionArray)
Parameters:
vModuleDescriptionArray -

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.