org.LexGrid.LexBIG.DataModel.Collections
Class SortDescriptionList

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

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

Class SortDescriptionList.

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

Constructor Summary
SortDescriptionList()
           
 
Method Summary
 void addSortDescription(int index, SortDescription vSortDescription)
           
 void addSortDescription(SortDescription vSortDescription)
           
 java.util.Enumeration<? extends SortDescription> enumerateSortDescription()
          Method enumerateSortDescription.
 SortDescription[] getSortDescription()
          Method getSortDescription.Returns the contents of the collection in an Array.
 SortDescription getSortDescription(int index)
          Method getSortDescription.
 int getSortDescriptionCount()
          Method getSortDescriptionCount.
 java.util.Iterator<? extends SortDescription> iterateSortDescription()
          Method iterateSortDescription.
 void removeAllSortDescription()
           
 boolean removeSortDescription(SortDescription vSortDescription)
          Method removeSortDescription.
 SortDescription removeSortDescriptionAt(int index)
          Method removeSortDescriptionAt.
 void setSortDescription(int index, SortDescription vSortDescription)
           
 void setSortDescription(SortDescription[] vSortDescriptionArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SortDescriptionList

public SortDescriptionList()
Method Detail

addSortDescription

public void addSortDescription(SortDescription vSortDescription)
                        throws java.lang.IndexOutOfBoundsException
Parameters:
vSortDescription -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addSortDescription

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

enumerateSortDescription

public java.util.Enumeration<? extends SortDescription> enumerateSortDescription()
Method enumerateSortDescription.

Returns:
an Enumeration over all possible elements of this collection

getSortDescription

public SortDescription getSortDescription(int index)
                                   throws java.lang.IndexOutOfBoundsException
Method getSortDescription.

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

getSortDescription

public SortDescription[] getSortDescription()
Method getSortDescription.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

getSortDescriptionCount

public int getSortDescriptionCount()
Method getSortDescriptionCount.

Returns:
the size of this collection

iterateSortDescription

public java.util.Iterator<? extends SortDescription> iterateSortDescription()
Method iterateSortDescription.

Returns:
an Iterator over all possible elements in this collection

removeAllSortDescription

public void removeAllSortDescription()

removeSortDescription

public boolean removeSortDescription(SortDescription vSortDescription)
Method removeSortDescription.

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

removeSortDescriptionAt

public SortDescription removeSortDescriptionAt(int index)
Method removeSortDescriptionAt.

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

setSortDescription

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

setSortDescription

public void setSortDescription(SortDescription[] vSortDescriptionArray)
Parameters:
vSortDescriptionArray -

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.