org.LexGrid.LexBIG.DataModel.cagrid
Class SetResolutionPolicy

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

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

Coded node set resolution policy.

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

Constructor Summary
SetResolutionPolicy()
           
 
Method Summary
 void addPropertyTypes(int index, PropertyType vPropertyTypes)
           
 void addPropertyTypes(PropertyType vPropertyTypes)
           
 java.util.Enumeration<PropertyType> enumeratePropertyTypes()
          Method enumeratePropertyTypes.
 LocalNameList getFilterOptions()
          Returns the value of field 'filterOptions'.
 java.lang.Integer getMaximumToReturn()
          Returns the value of field 'maximumToReturn'.
 LocalNameList getPropertyNames()
          Returns the value of field 'propertyNames'.
 PropertyType[] getPropertyTypes()
          Method getPropertyTypes.Returns the contents of the collection in an Array.
 PropertyType getPropertyTypes(int index)
          Method getPropertyTypes.
 int getPropertyTypesCount()
          Method getPropertyTypesCount.
 java.lang.Boolean getResolveConcepts()
          Returns the value of field 'resolveConcepts'.
 SortOptionList getSortOptions()
          Returns the value of field 'sortOptions'.
 java.lang.Boolean isResolveConcepts()
          Returns the value of field 'resolveConcepts'.
 java.util.Iterator<PropertyType> iteratePropertyTypes()
          Method iteratePropertyTypes.
 void removeAllPropertyTypes()
           
 boolean removePropertyTypes(PropertyType vPropertyTypes)
          Method removePropertyTypes.
 PropertyType removePropertyTypesAt(int index)
          Method removePropertyTypesAt.
 void setFilterOptions(LocalNameList filterOptions)
          Sets the value of field 'filterOptions'.
 void setMaximumToReturn(java.lang.Integer maximumToReturn)
          Sets the value of field 'maximumToReturn'.
 void setPropertyNames(LocalNameList propertyNames)
          Sets the value of field 'propertyNames'.
 void setPropertyTypes(int index, PropertyType vPropertyTypes)
           
 void setPropertyTypes(PropertyType[] vPropertyTypesArray)
           
 void setResolveConcepts(java.lang.Boolean resolveConcepts)
          Sets the value of field 'resolveConcepts'.
 void setSortOptions(SortOptionList sortOptions)
          Sets the value of field 'sortOptions'.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetResolutionPolicy

public SetResolutionPolicy()
Method Detail

addPropertyTypes

public void addPropertyTypes(PropertyType vPropertyTypes)
                      throws java.lang.IndexOutOfBoundsException
Parameters:
vPropertyTypes -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPropertyTypes

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

enumeratePropertyTypes

public java.util.Enumeration<PropertyType> enumeratePropertyTypes()
Method enumeratePropertyTypes.

Returns:
an Enumeration over all possible elements of this collection

getFilterOptions

public LocalNameList getFilterOptions()
Returns the value of field 'filterOptions'.

Returns:
the value of field 'FilterOptions'.

getMaximumToReturn

public java.lang.Integer getMaximumToReturn()
Returns the value of field 'maximumToReturn'. The field 'maximumToReturn' has the following description: Maximum number of coded concept entries to return.

Returns:
the value of field 'MaximumToReturn'.

getPropertyNames

public LocalNameList getPropertyNames()
Returns the value of field 'propertyNames'.

Returns:
the value of field 'PropertyNames'.

getPropertyTypes

public PropertyType getPropertyTypes(int index)
                              throws java.lang.IndexOutOfBoundsException
Method getPropertyTypes.

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

getPropertyTypes

public PropertyType[] getPropertyTypes()
Method getPropertyTypes.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

getPropertyTypesCount

public int getPropertyTypesCount()
Method getPropertyTypesCount.

Returns:
the size of this collection

getResolveConcepts

public java.lang.Boolean getResolveConcepts()
Returns the value of field 'resolveConcepts'. The field 'resolveConcepts' has the following description: True to fill in all information of the concept in the referencedEntry within ResolvedConceptReference.

Returns:
the value of field 'ResolveConcepts'.

getSortOptions

public SortOptionList getSortOptions()
Returns the value of field 'sortOptions'.

Returns:
the value of field 'SortOptions'.

isResolveConcepts

public java.lang.Boolean isResolveConcepts()
Returns the value of field 'resolveConcepts'. The field 'resolveConcepts' has the following description: True to fill in all information of the concept in the referencedEntry within ResolvedConceptReference.

Returns:
the value of field 'ResolveConcepts'.

iteratePropertyTypes

public java.util.Iterator<PropertyType> iteratePropertyTypes()
Method iteratePropertyTypes.

Returns:
an Iterator over all possible elements in this collection

removeAllPropertyTypes

public void removeAllPropertyTypes()

removePropertyTypes

public boolean removePropertyTypes(PropertyType vPropertyTypes)
Method removePropertyTypes.

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

removePropertyTypesAt

public PropertyType removePropertyTypesAt(int index)
Method removePropertyTypesAt.

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

setFilterOptions

public void setFilterOptions(LocalNameList filterOptions)
Sets the value of field 'filterOptions'.

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

setMaximumToReturn

public void setMaximumToReturn(java.lang.Integer maximumToReturn)
Sets the value of field 'maximumToReturn'. The field 'maximumToReturn' has the following description: Maximum number of coded concept entries to return.

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

setPropertyNames

public void setPropertyNames(LocalNameList propertyNames)
Sets the value of field 'propertyNames'.

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

setPropertyTypes

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

setPropertyTypes

public void setPropertyTypes(PropertyType[] vPropertyTypesArray)
Parameters:
vPropertyTypesArray -

setResolveConcepts

public void setResolveConcepts(java.lang.Boolean resolveConcepts)
Sets the value of field 'resolveConcepts'. The field 'resolveConcepts' has the following description: True to fill in all information of the concept in the referencedEntry within ResolvedConceptReference.

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

setSortOptions

public void setSortOptions(SortOptionList sortOptions)
Sets the value of field 'sortOptions'.

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

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.