org.lexevs.cts2.query
Interface CodeSystemQueryOperation

All Known Implementing Classes:
CodeSystemQueryOperationImpl

public interface CodeSystemQueryOperation


Method Summary
 AssociationEntity getAssociationTypeDetails(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String associationName)
          Return detailed information for a certain associationType
 CodingScheme getCodeSystemDetails(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag)
          Return a detailed codingScheme according to provided codingName and versionOrTag
 Entity getConceptDetails(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String code, java.lang.String namespace)
          Return an instance of Entity according the requests
 java.util.List<SupportedAssociation> listAssociationTypes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag)
          List all the associationTypes in a specific codingSystem
 ResolvedConceptReferencesIterator listCodeSystemConcepts(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes, SortOptionList sortOptionList)
          List the concepts in a specific codingSystem
 CodingSchemeRenderingList listCodeSystems(CodingSchemeSummary queryByExample)
          List the coding systems that are available in cts 2 system
 

Method Detail

listCodeSystems

CodingSchemeRenderingList listCodeSystems(CodingSchemeSummary queryByExample)
List the coding systems that are available in cts 2 system

Parameters:
queryByExample - . Query by example.
Returns:
a list of codingSystems
Throws:
LBInvocationException

getCodeSystemDetails

CodingScheme getCodeSystemDetails(java.lang.String codingSchemeName,
                                  CodingSchemeVersionOrTag versionOrTag)
Return a detailed codingScheme according to provided codingName and versionOrTag

Parameters:
codingSchemeName -
versionOrTag -
Returns:
codingSystem
Throws:
LBInvocationException
LBParameterException

listCodeSystemConcepts

ResolvedConceptReferencesIterator listCodeSystemConcepts(java.lang.String codingSchemeName,
                                                         CodingSchemeVersionOrTag versionOrTag,
                                                         LocalNameList entityTypes,
                                                         SortOptionList sortOptionList)
List the concepts in a specific codingSystem

Parameters:
codingSchemeName -
versionOrTag -
entityTypes - (Optional)
sortOptionList - (Optional)
Returns:
Iterator of codingSystemEntities
Throws:
LBException

getConceptDetails

Entity getConceptDetails(java.lang.String codingSchemeName,
                         CodingSchemeVersionOrTag versionOrTag,
                         java.lang.String code,
                         java.lang.String namespace)
Return an instance of Entity according the requests

Parameters:
codingSchemeName -
versionOrTag -
code -
namespace -
Returns:
coding system entity
Throws:
LBException

listAssociationTypes

java.util.List<SupportedAssociation> listAssociationTypes(java.lang.String codingSchemeName,
                                                          CodingSchemeVersionOrTag versionOrTag)
List all the associationTypes in a specific codingSystem

Parameters:
codingSchemeName -
versionOrTag -
Returns:
a list of association types

getAssociationTypeDetails

AssociationEntity getAssociationTypeDetails(java.lang.String codingSchemeName,
                                            CodingSchemeVersionOrTag versionOrTag,
                                            java.lang.String associationName)
Return detailed information for a certain associationType

Parameters:
codingSchemeName -
versionOrTag -
associationName -
Returns:
association type detail
Throws:
LBException

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.