org.LexGrid.LexBIG.DataModel.Collections
Class ResolvedConceptReferenceList

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.Collections.ResolvedConceptReferenceList
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
LazyLoadableResolvedConceptReferenceList

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

Class ResolvedConceptReferenceList.

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

Constructor Summary
ResolvedConceptReferenceList()
           
 
Method Summary
 void addResolvedConceptReference(int index, ResolvedConceptReference vResolvedConceptReference)
           
 void addResolvedConceptReference(ResolvedConceptReference vResolvedConceptReference)
           
 java.util.Enumeration<? extends ResolvedConceptReference> enumerateResolvedConceptReference()
          Method enumerateResolvedConceptReference.
 java.lang.Boolean getIncomplete()
          Returns the value of field 'incomplete'.
 ResolvedConceptReference[] getResolvedConceptReference()
          Method getResolvedConceptReference.Returns the contents of the collection in an Array.
 ResolvedConceptReference getResolvedConceptReference(int index)
          Method getResolvedConceptReference.
 int getResolvedConceptReferenceCount()
          Method getResolvedConceptReferenceCount.
 java.lang.Boolean isIncomplete()
          Returns the value of field 'incomplete'.
 java.util.Iterator<? extends ResolvedConceptReference> iterateResolvedConceptReference()
          Method iterateResolvedConceptReference.
 void removeAllResolvedConceptReference()
           
 boolean removeResolvedConceptReference(ResolvedConceptReference vResolvedConceptReference)
          Method removeResolvedConceptReference.
 ResolvedConceptReference removeResolvedConceptReferenceAt(int index)
          Method removeResolvedConceptReferenceAt.
 void setIncomplete(java.lang.Boolean incomplete)
          Sets the value of field 'incomplete'.
 void setResolvedConceptReference(int index, ResolvedConceptReference vResolvedConceptReference)
           
 void setResolvedConceptReference(ResolvedConceptReference[] vResolvedConceptReferenceArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResolvedConceptReferenceList

public ResolvedConceptReferenceList()
Method Detail

addResolvedConceptReference

public void addResolvedConceptReference(ResolvedConceptReference vResolvedConceptReference)
                                 throws java.lang.IndexOutOfBoundsException
Parameters:
vResolvedConceptReference -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addResolvedConceptReference

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

enumerateResolvedConceptReference

public java.util.Enumeration<? extends ResolvedConceptReference> enumerateResolvedConceptReference()
Method enumerateResolvedConceptReference.

Returns:
an Enumeration over all possible elements of this collection

getIncomplete

public java.lang.Boolean getIncomplete()
Returns the value of field 'incomplete'. The field 'incomplete' has the following description: True means that the maxToReturn or some other limit resulted in the list being incomplete. Default: false

Returns:
the value of field 'Incomplete'.

getResolvedConceptReference

public ResolvedConceptReference getResolvedConceptReference(int index)
                                                     throws java.lang.IndexOutOfBoundsException
Method getResolvedConceptReference.

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

getResolvedConceptReference

public ResolvedConceptReference[] getResolvedConceptReference()
Method getResolvedConceptReference.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

getResolvedConceptReferenceCount

public int getResolvedConceptReferenceCount()
Method getResolvedConceptReferenceCount.

Returns:
the size of this collection

isIncomplete

public java.lang.Boolean isIncomplete()
Returns the value of field 'incomplete'. The field 'incomplete' has the following description: True means that the maxToReturn or some other limit resulted in the list being incomplete. Default: false

Returns:
the value of field 'Incomplete'.

iterateResolvedConceptReference

public java.util.Iterator<? extends ResolvedConceptReference> iterateResolvedConceptReference()
Method iterateResolvedConceptReference.

Returns:
an Iterator over all possible elements in this collection

removeAllResolvedConceptReference

public void removeAllResolvedConceptReference()

removeResolvedConceptReference

public boolean removeResolvedConceptReference(ResolvedConceptReference vResolvedConceptReference)
Method removeResolvedConceptReference.

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

removeResolvedConceptReferenceAt

public ResolvedConceptReference removeResolvedConceptReferenceAt(int index)
Method removeResolvedConceptReferenceAt.

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

setIncomplete

public void setIncomplete(java.lang.Boolean incomplete)
Sets the value of field 'incomplete'. The field 'incomplete' has the following description: True means that the maxToReturn or some other limit resulted in the list being incomplete. Default: false

Parameters:
incomplete - the value of field 'incomplete'.

setResolvedConceptReference

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

setResolvedConceptReference

public void setResolvedConceptReference(ResolvedConceptReference[] vResolvedConceptReferenceArray)
Parameters:
vResolvedConceptReferenceArray -

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.