org.LexGrid.LexBIG.DataModel.InterfaceElements
Class SortDescription

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.InterfaceElements.ModuleDescription
      extended by org.LexGrid.LexBIG.DataModel.InterfaceElements.ExtensionDescription
          extended by org.LexGrid.LexBIG.DataModel.InterfaceElements.SortDescription
All Implemented Interfaces:
java.io.Serializable

public class SortDescription
extends ExtensionDescription
implements java.io.Serializable

A description of of a LexBIG extension module.

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

Constructor Summary
SortDescription()
           
 
Method Summary
 void addRestrictToContext(int index, SortContext vRestrictToContext)
           
 void addRestrictToContext(SortContext vRestrictToContext)
           
 java.util.Enumeration<? extends SortContext> enumerateRestrictToContext()
          Method enumerateRestrictToContext.
 SortContext[] getRestrictToContext()
          Method getRestrictToContext.Returns the contents of the collection in an Array.
 SortContext getRestrictToContext(int index)
          Method getRestrictToContext.
 int getRestrictToContextCount()
          Method getRestrictToContextCount.
 java.util.Iterator<? extends SortContext> iterateRestrictToContext()
          Method iterateRestrictToContext.
 void removeAllRestrictToContext()
           
 boolean removeRestrictToContext(SortContext vRestrictToContext)
          Method removeRestrictToContext.
 SortContext removeRestrictToContextAt(int index)
          Method removeRestrictToContextAt.
 void setRestrictToContext(int index, SortContext vRestrictToContext)
           
 void setRestrictToContext(SortContext[] vRestrictToContextArray)
           
 
Methods inherited from class org.LexGrid.LexBIG.DataModel.InterfaceElements.ExtensionDescription
getExtensionBaseClass, getExtensionClass, getExtensionProvider, setExtensionBaseClass, setExtensionClass, setExtensionProvider
 
Methods inherited from class org.LexGrid.LexBIG.DataModel.InterfaceElements.ModuleDescription
getDescription, getName, getVersion, setDescription, setName, setVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SortDescription

public SortDescription()
Method Detail

addRestrictToContext

public void addRestrictToContext(SortContext vRestrictToContext)
                          throws java.lang.IndexOutOfBoundsException
Parameters:
vRestrictToContext -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRestrictToContext

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

enumerateRestrictToContext

public java.util.Enumeration<? extends SortContext> enumerateRestrictToContext()
Method enumerateRestrictToContext.

Returns:
an Enumeration over all possible elements of this collection

getRestrictToContext

public SortContext getRestrictToContext(int index)
                                 throws java.lang.IndexOutOfBoundsException
Method getRestrictToContext.

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

getRestrictToContext

public SortContext[] getRestrictToContext()
Method getRestrictToContext.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

getRestrictToContextCount

public int getRestrictToContextCount()
Method getRestrictToContextCount.

Returns:
the size of this collection

iterateRestrictToContext

public java.util.Iterator<? extends SortContext> iterateRestrictToContext()
Method iterateRestrictToContext.

Returns:
an Iterator over all possible elements in this collection

removeAllRestrictToContext

public void removeAllRestrictToContext()

removeRestrictToContext

public boolean removeRestrictToContext(SortContext vRestrictToContext)
Method removeRestrictToContext.

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

removeRestrictToContextAt

public SortContext removeRestrictToContextAt(int index)
Method removeRestrictToContextAt.

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

setRestrictToContext

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

setRestrictToContext

public void setRestrictToContext(SortContext[] vRestrictToContextArray)
Parameters:
vRestrictToContextArray -

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.