org.LexGrid.LexBIG.cagrid.adapters
Class LexBIGServiceConvenienceMethodsGridAdapter

java.lang.Object
  extended by org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceConvenienceMethodsGridAdapter
All Implemented Interfaces:
java.io.Serializable, LexBIGServiceConvenienceMethodsGrid, org.LexGrid.LexBIG.Extensions.Extendable, org.LexGrid.LexBIG.Extensions.Generic.GenericExtension

public class LexBIGServiceConvenienceMethodsGridAdapter
extends java.lang.Object
implements LexBIGServiceConvenienceMethodsGrid, org.LexGrid.LexBIG.Extensions.Generic.GenericExtension

See Also:
Serialized Form

Constructor Summary
LexBIGServiceConvenienceMethodsGridAdapter(LexBIGServiceConvenienceMethodsClient client)
           
 
Method Summary
 CodedNodeSetGrid createCodeNodeSet(org.LexGrid.LexBIG.DataModel.cagrid.ConceptIdentification[] conceptCodes, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Create a CodedNodeSet from a set of concept codes in a coding scheme.
 org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification[] getAssociationForwardAndReverseNames(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return all the association forward name and reverse name for the coding scheme.
 org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification getAssociationForwardName(org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification association, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return the forward name for the identified association.
 org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification[] getAssociationForwardNames(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return all the association forward name for the coding scheme.
 org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification getAssociationReverseName(org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification association, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return the reverse name for the identified association.
 org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification[] getAssociationReverseNames(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return all the association reverse name for the coding scheme.
 org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight getCodingSchemeCopyright(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return the copyright text for the coding scheme.
 org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification associationName)
          Return the coding schemes who supported association matching with AssociationIdentification.
 java.lang.String getDescription()
           
 org.LexGrid.LexBIG.DataModel.cagrid.HierarchyIdentification[] getHierarchyIDs(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Returns the identifiers for hierarchical relationships available for navigation within a coding scheme.
 org.LexGrid.LexBIG.DataModel.Collections.AssociationList getHierarchyLevelNext(org.LexGrid.LexBIG.DataModel.cagrid.HierarchyResolutionPolicy policy, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return a representation of associations between a concept and its immediate decendents.
 org.LexGrid.LexBIG.DataModel.Collections.AssociationList getHierarchyLevelPrev(org.LexGrid.LexBIG.DataModel.cagrid.HierarchyResolutionPolicy policy, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return a representation of associations between a concept and its immediate ancestor(s).
 org.LexGrid.LexBIG.DataModel.Collections.AssociationList getHierarchyPathToRoot(org.LexGrid.LexBIG.DataModel.cagrid.HierarchyResolutionPolicy policy, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.enums.HierarchyPathResolveOption resolveOption)
          Return a representation of associations between a concept and hierarchical root node(s).
 org.LexGrid.LexBIG.DataModel.Collections.ResolvedConceptReferenceList getHierarchyRoots(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.HierarchyIdentification hierarchyID)
          Returns all root nodes for the given hierarchy and coding scheme.
 CodedNodeSetGrid getHierarchyRootSet(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.HierarchyIdentification hierarchyID)
          Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted.
 org.LexGrid.LexBIG.Extensions.Generic.LexBIGServiceConvenienceMethods getLexBIGServiceConvenienceMethodsInterface()
           
 java.lang.String getName()
           
 java.lang.String getProvider()
           
 org.LexGrid.LexBIG.DataModel.InterfaceElements.CodingSchemeRendering getRenderingDetail(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return detailed rendering information (including coding scheme summary, version and status information, reference links, etc) for the given coding scheme; null if not available.
 java.lang.String getVersion()
           
 org.LexGrid.LexBIG.DataModel.cagrid.CodeState isCodeRetired(org.LexGrid.LexBIG.DataModel.cagrid.ConceptIdentification conceptCode, org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Indicates if the given code is considered retired or inactive within context of the provided scheme.
 org.LexGrid.LexBIG.DataModel.cagrid.Direction isForwardName(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification directionalName)
          Return true if directionalName is the forward name of an association for the coding scheme.
 org.LexGrid.LexBIG.DataModel.cagrid.Direction isReverseName(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification directionalName)
          Return true if directionalName is the reverse name of an association for the coding scheme.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LexBIGServiceConvenienceMethodsGridAdapter

public LexBIGServiceConvenienceMethodsGridAdapter(LexBIGServiceConvenienceMethodsClient client)
                                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException
Method Detail

createCodeNodeSet

public CodedNodeSetGrid createCodeNodeSet(org.LexGrid.LexBIG.DataModel.cagrid.ConceptIdentification[] conceptCodes,
                                          org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                          org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                   throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                          org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                          java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Create a CodedNodeSet from a set of concept codes in a coding scheme.

Specified by:
createCodeNodeSet in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
conceptCodes - The concept codes for included items.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
A CodedNodeSet representing the corresponding coded entries.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationForwardAndReverseNames

public org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification[] getAssociationForwardAndReverseNames(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                                            org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                                     throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                                            org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                            java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return all the association forward name and reverse name for the coding scheme.

Specified by:
getAssociationForwardAndReverseNames in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationForwardName

public org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification getAssociationForwardName(org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification association,
                                                                                                          org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                                          org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                                   throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                                          org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                          java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return the forward name for the identified association.

Specified by:
getAssociationForwardName in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
association - Primary name of the association.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationForwardNames

public org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification[] getAssociationForwardNames(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                                             org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                                      throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                                             org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                             java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return all the association forward name for the coding scheme.

Specified by:
getAssociationForwardNames in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationReverseName

public org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification getAssociationReverseName(org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification association,
                                                                                                          org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                                          org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                                   throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                                          org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                          java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return the reverse name for the identified association.

Specified by:
getAssociationReverseName in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
association - Basic (non-directional) name of the association.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationReverseNames

public org.LexGrid.LexBIG.DataModel.cagrid.DirectionalAssociationIdentification[] getAssociationReverseNames(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                                             org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                                      throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                                             org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                             java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return all the association reverse name for the coding scheme.

Specified by:
getAssociationReverseNames in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getCodingSchemesWithSupportedAssociation

public org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification associationName)
                                                                                                            throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                                                   org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                                   java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return the coding schemes who supported association matching with AssociationIdentification. The search is performed only for loaded coding schemes.

Specified by:
getCodingSchemesWithSupportedAssociation in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
associationName - Association name to search for. It is case sensitive.
Returns:
List of coding schemes who has supported association matching with the value of AssociationIdentification
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyIDs

public org.LexGrid.LexBIG.DataModel.cagrid.HierarchyIdentification[] getHierarchyIDs(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                     org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                              throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                     org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                     java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Returns the identifiers for hierarchical relationships available for navigation within a coding scheme. These identifiers can be submitted to the getHierarchyBroader() or getHierarchyNarrower() methods to navigate corresponding tree structures.

Possible return values are defined by the LexBIG model (see http://informatics.mayo.edu/LexGrid/downloads/LexGrid%20Model/ schemas/2008/01/EAwebpublish/index.htm).

Specified by:
getHierarchyIDs in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The array of identifiers; empty if no hierarchies are explicitly defined (the ontology is 'flat').
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyLevelNext

public org.LexGrid.LexBIG.DataModel.Collections.AssociationList getHierarchyLevelNext(org.LexGrid.LexBIG.DataModel.cagrid.HierarchyResolutionPolicy policy,
                                                                                      org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                      org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                               throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                      org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                      java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return a representation of associations between a concept and its immediate decendents. The resolved association list represents the next branch of the hierarchy when visualized in a top (root) to bottom (leaf) representation.

Specified by:
getHierarchyLevelNext in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
policy - Policy for resolving the hierarchy
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The list of associations and referenced concepts representing immediate decendents within the hierarchy; empty if no items are found.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyLevelPrev

public org.LexGrid.LexBIG.DataModel.Collections.AssociationList getHierarchyLevelPrev(org.LexGrid.LexBIG.DataModel.cagrid.HierarchyResolutionPolicy policy,
                                                                                      org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                      org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                               throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                      org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                      java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return a representation of associations between a concept and its immediate ancestor(s). The resolved association list represents the previous level of the hierarchy when visualized in a top (root) to bottom (leaf) representation.

Specified by:
getHierarchyLevelPrev in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
policy - Policy for resolving the CodedNodeSet
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The list of associations and referenced concepts representing the immediate ancestor(s) within the hierarchy; empty if no items are found.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyPathToRoot

public org.LexGrid.LexBIG.DataModel.Collections.AssociationList getHierarchyPathToRoot(org.LexGrid.LexBIG.DataModel.cagrid.HierarchyResolutionPolicy policy,
                                                                                       org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                       org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                                                                       org.LexGrid.LexBIG.DataModel.enums.HierarchyPathResolveOption resolveOption)
                                                                                throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                       org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                       java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return a representation of associations between a concept and hierarchical root node(s). The resolved association list represents the path within the hierarchy from traversed from bottom (leaf) to top (root).

Specified by:
getHierarchyPathToRoot in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
policy - Policy for resolving the CodedNodeSet
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The list of associations and referenced concepts representing the path to root node(s) within the hierarchy; empty if no items are found. If not empty, each association in the initial list represents a separate path to root for the given concept.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyRootSet

public CodedNodeSetGrid getHierarchyRootSet(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                            org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                            org.LexGrid.LexBIG.DataModel.cagrid.HierarchyIdentification hierarchyID)
                                     throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                            org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                            java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Specified by:
getHierarchyRootSet in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIdentifications() method. If null, roots for all registered hierarchies are returned.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyRoots

public org.LexGrid.LexBIG.DataModel.Collections.ResolvedConceptReferenceList getHierarchyRoots(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                               org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                                                                               org.LexGrid.LexBIG.DataModel.cagrid.HierarchyIdentification hierarchyID)
                                                                                        throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                               org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                               java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Returns all root nodes for the given hierarchy and coding scheme. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Specified by:
getHierarchyRoots in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIdentifications() method. If null, roots for all registered hierarchies are returned.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getRenderingDetail

public org.LexGrid.LexBIG.DataModel.InterfaceElements.CodingSchemeRendering getRenderingDetail(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                               org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                        throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                               org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                               java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return detailed rendering information (including coding scheme summary, version and status information, reference links, etc) for the given coding scheme; null if not available.

Specified by:
getRenderingDetail in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

isCodeRetired

public org.LexGrid.LexBIG.DataModel.cagrid.CodeState isCodeRetired(org.LexGrid.LexBIG.DataModel.cagrid.ConceptIdentification conceptCode,
                                                                   org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                   org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                            throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                   org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                   java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Indicates if the given code is considered retired or inactive within context of the provided scheme.

Specified by:
isCodeRetired in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
conceptCode - The concept code to evaluate.
codingScheme - The local name or URN of the coding scheme to query.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme to query.
Returns:
true if retired; false otherwise
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

isForwardName

public org.LexGrid.LexBIG.DataModel.cagrid.Direction isForwardName(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                   org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                                                   org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification directionalName)
                                                            throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                   org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                   java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return true if directionalName is the forward name of an association for the coding scheme.

Specified by:
isForwardName in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
directionalName - The directionalName string
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

isReverseName

public org.LexGrid.LexBIG.DataModel.cagrid.Direction isReverseName(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                   org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                                                   org.LexGrid.LexBIG.DataModel.cagrid.AssociationIdentification directionalName)
                                                            throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                   org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                   java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return true if directionalName is the reverse name of an association for the coding scheme.

Specified by:
isReverseName in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
directionalName - The directionalName string
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getCodingSchemeCopyright

public org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight getCodingSchemeCopyright(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                          org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                   throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException,
                                                                                          org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                          java.rmi.RemoteException
Description copied from interface: LexBIGServiceConvenienceMethodsGrid
Return the copyright text for the coding scheme.

Specified by:
getCodingSchemeCopyright in interface LexBIGServiceConvenienceMethodsGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface org.LexGrid.LexBIG.Extensions.Extendable

getName

public java.lang.String getName()
Specified by:
getName in interface org.LexGrid.LexBIG.Extensions.Extendable

getProvider

public java.lang.String getProvider()
Specified by:
getProvider in interface org.LexGrid.LexBIG.Extensions.Extendable

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface org.LexGrid.LexBIG.Extensions.Extendable

getLexBIGServiceConvenienceMethodsInterface

public org.LexGrid.LexBIG.Extensions.Generic.LexBIGServiceConvenienceMethods getLexBIGServiceConvenienceMethodsInterface()
                                                                                                                  throws java.lang.Exception
Throws:
java.lang.Exception