org.LexGrid.REST.valueSets
Class PickLists

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.valueSets.PickLists
All Implemented Interfaces:
java.io.Serializable

public class PickLists
extends LexGridBase
implements java.io.Serializable

A collection of pick list definitions.

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

Constructor Summary
PickLists()
           
 
Method Summary
 void addPickListDefinition(int index, PickListDefinition vPickListDefinition)
           
 void addPickListDefinition(PickListDefinition vPickListDefinition)
           
 java.util.Enumeration<? extends PickListDefinition> enumeratePickListDefinition()
          Method enumeratePickListDefinition.
 PickListDefinition[] getPickListDefinition()
          Method getPickListDefinition.Returns the contents of the collection in an Array.
 PickListDefinition getPickListDefinition(int index)
          Method getPickListDefinition.
 java.util.List<PickListDefinition> getPickListDefinitionAsReference()
          Method getPickListDefinitionAsReference.Returns a reference to '_pickListDefinitionList'.
 int getPickListDefinitionCount()
          Method getPickListDefinitionCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends PickListDefinition> iteratePickListDefinition()
          Method iteratePickListDefinition.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllPickListDefinition()
           
 boolean removePickListDefinition(PickListDefinition vPickListDefinition)
          Method removePickListDefinition.
 PickListDefinition removePickListDefinitionAt(int index)
          Method removePickListDefinitionAt.
 void setPickListDefinition(int index, PickListDefinition vPickListDefinition)
           
 void setPickListDefinition(java.util.List<PickListDefinition> vPickListDefinitionList)
          Sets the value of '_pickListDefinitionList' by copying the given Vector.
 void setPickListDefinition(PickListDefinition[] vPickListDefinitionArray)
           
 void setPickListDefinitionAsReference(java.util.List<PickListDefinition> pickListDefinitionList)
          Deprecated.  
static PickLists unmarshalPickLists(java.io.Reader reader)
          Method unmarshalPickLists.
 void validate()
           
 
Methods inherited from class org.mayo.edu.lgModel.LexGridBase
getParent, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PickLists

public PickLists()
Method Detail

addPickListDefinition

public void addPickListDefinition(PickListDefinition vPickListDefinition)
                           throws java.lang.IndexOutOfBoundsException
Parameters:
vPickListDefinition -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPickListDefinition

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

enumeratePickListDefinition

public java.util.Enumeration<? extends PickListDefinition> enumeratePickListDefinition()
Method enumeratePickListDefinition.

Returns:
an Enumeration over all possible elements of this collection

getPickListDefinition

public PickListDefinition getPickListDefinition(int index)
                                         throws java.lang.IndexOutOfBoundsException
Method getPickListDefinition.

Parameters:
index -
Returns:
the value of the org.LexGrid.REST.valueSets.PickListDefinition at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getPickListDefinition

public PickListDefinition[] getPickListDefinition()
Method getPickListDefinition.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

getPickListDefinitionAsReference

public java.util.List<PickListDefinition> getPickListDefinitionAsReference()
Method getPickListDefinitionAsReference.Returns a reference to '_pickListDefinitionList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getPickListDefinitionCount

public int getPickListDefinitionCount()
Method getPickListDefinitionCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iteratePickListDefinition

public java.util.Iterator<? extends PickListDefinition> iteratePickListDefinition()
Method iteratePickListDefinition.

Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllPickListDefinition

public void removeAllPickListDefinition()

removePickListDefinition

public boolean removePickListDefinition(PickListDefinition vPickListDefinition)
Method removePickListDefinition.

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

removePickListDefinitionAt

public PickListDefinition removePickListDefinitionAt(int index)
Method removePickListDefinitionAt.

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

setPickListDefinition

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

setPickListDefinition

public void setPickListDefinition(PickListDefinition[] vPickListDefinitionArray)
Parameters:
vPickListDefinitionArray -

setPickListDefinition

public void setPickListDefinition(java.util.List<PickListDefinition> vPickListDefinitionList)
Sets the value of '_pickListDefinitionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vPickListDefinitionList - the Vector to copy.

setPickListDefinitionAsReference

public void setPickListDefinitionAsReference(java.util.List<PickListDefinition> pickListDefinitionList)
Deprecated. 

Sets the value of '_pickListDefinitionList' by setting it to the given Vector. No type checking is performed.

Parameters:
pickListDefinitionList - the Vector to set.

unmarshalPickLists

public static PickLists unmarshalPickLists(java.io.Reader reader)
                                    throws org.exolab.castor.xml.MarshalException,
                                           org.exolab.castor.xml.ValidationException
Method unmarshalPickLists.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.valueSets.PickLists
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

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.