org.LexGrid.LexBIG.DataModel.Collections
Class SortOptionList

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

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

Class SortOptionList.

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

Constructor Summary
SortOptionList()
           
 
Method Summary
 void addEntry(int index, SortOption vEntry)
           
 void addEntry(SortOption vEntry)
           
 java.util.Enumeration<? extends SortOption> enumerateEntry()
          Method enumerateEntry.
 SortOption[] getEntry()
          Method getEntry.Returns the contents of the collection in an Array.
 SortOption getEntry(int index)
          Method getEntry.
 int getEntryCount()
          Method getEntryCount.
 java.util.Iterator<? extends SortOption> iterateEntry()
          Method iterateEntry.
 void removeAllEntry()
           
 boolean removeEntry(SortOption vEntry)
          Method removeEntry.
 SortOption removeEntryAt(int index)
          Method removeEntryAt.
 void setEntry(int index, SortOption vEntry)
           
 void setEntry(SortOption[] vEntryArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SortOptionList

public SortOptionList()
Method Detail

addEntry

public void addEntry(SortOption vEntry)
              throws java.lang.IndexOutOfBoundsException
Parameters:
vEntry -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addEntry

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

enumerateEntry

public java.util.Enumeration<? extends SortOption> enumerateEntry()
Method enumerateEntry.

Returns:
an Enumeration over all possible elements of this collection

getEntry

public SortOption getEntry(int index)
                    throws java.lang.IndexOutOfBoundsException
Method getEntry.

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

getEntry

public SortOption[] getEntry()
Method getEntry.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

getEntryCount

public int getEntryCount()
Method getEntryCount.

Returns:
the size of this collection

iterateEntry

public java.util.Iterator<? extends SortOption> iterateEntry()
Method iterateEntry.

Returns:
an Iterator over all possible elements in this collection

removeAllEntry

public void removeAllEntry()

removeEntry

public boolean removeEntry(SortOption vEntry)
Method removeEntry.

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

removeEntryAt

public SortOption removeEntryAt(int index)
Method removeEntryAt.

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

setEntry

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

setEntry

public void setEntry(SortOption[] vEntryArray)
Parameters:
vEntryArray -

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.