org.lexgrid.usagecontext
Interface LexEVSUsageContextServices

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
LexEVSUsageContextServicesImpl

public interface LexEVSUsageContextServices
extends java.io.Serializable

LexEVS Usage Context Services.

Author:
Sridhar Dwarkanath

Method Summary
 CodedNodeSet getUsageContextCodedNodeSet(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Returns coded node set for usage context entities.
 CodingScheme getUsageContextCodingScheme(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Gets the Usage Context coding scheme.
 CodingSchemeSummary getUsageContextCodingSchemeSummary(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Gets the Usage Context coding scheme summary.
 java.util.List<Entity> getUsageContextEntitisWithName(java.lang.String usageContextName, java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag, CodedNodeSet.SearchDesignationOption option, java.lang.String matchAlgorithm, java.lang.String language)
          Returns list of usage context entities matching the name provided.
 Entity getUsageContextEntity(java.lang.String usageContextId, java.lang.String namespace, java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Returns UsageContext entity object with usageContextId.
 java.util.List<Entity> listAllUsageContextEntities(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Gets all the usage context found in the system as entities.
 java.util.List<java.lang.String> listAllUsageContextIds(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Returns all the usage context identifiers found in the system.
 

Method Detail

getUsageContextCodingScheme

CodingScheme getUsageContextCodingScheme(java.lang.String codingSchemeNameOrURI,
                                         CodingSchemeVersionOrTag versionOrTag)
                                         throws LBException
Gets the Usage Context coding scheme.

Parameters:
versionOrTag - usageContext coding scheme version or tag
Returns:
the usage context coding scheme
Throws:
LBException

getUsageContextCodingSchemeSummary

CodingSchemeSummary getUsageContextCodingSchemeSummary(java.lang.String codingSchemeNameOrURI,
                                                       CodingSchemeVersionOrTag versionOrTag)
                                                       throws LBException
Gets the Usage Context coding scheme summary.

Parameters:
codingSchemeNameOrURI - usage context coding scheme name or uri
versionOrTag - usage context coding scheme version or tag
Returns:
the usage context coding scheme summary
Throws:
LBException

getUsageContextEntity

Entity getUsageContextEntity(java.lang.String usageContextId,
                             java.lang.String namespace,
                             java.lang.String codingSchemeNameOrURI,
                             CodingSchemeVersionOrTag versionOrTag)
                             throws LBException
Returns UsageContext entity object with usageContextId.

Parameters:
usageContextId - id of usage context
namespace - usage context namespace
codingSchemeNameOrURI - usage context coding scheme name or uri
versionOrTag - usageContext coding scheme version or tag
Returns:
usage context entity object
Throws:
LBException

getUsageContextEntitisWithName

java.util.List<Entity> getUsageContextEntitisWithName(java.lang.String usageContextName,
                                                      java.lang.String codingSchemeNameOrURI,
                                                      CodingSchemeVersionOrTag versionOrTag,
                                                      CodedNodeSet.SearchDesignationOption option,
                                                      java.lang.String matchAlgorithm,
                                                      java.lang.String language)
                                                      throws LBException
Returns list of usage context entities matching the name provided.

Parameters:
usageContextName - match name of usage context
codingSchemeNameOrURI - usage context coding scheme name or uri
versionOrTag - usage context coding scheme version or tag
option - Indicates the designations to search (one of the enumerated type SearchDesignationOption).
matchAlgorithm - Local name of the match algorithm - possible algorithms are returned in LexBigService.getMatchAlgorithms().
language - Language of search string. If missing, use the default language specified in the context.
Returns:
list of entities containing matching usage context name
Throws:
LBException

getUsageContextCodedNodeSet

CodedNodeSet getUsageContextCodedNodeSet(java.lang.String codingSchemeNameOrURI,
                                         CodingSchemeVersionOrTag versionOrTag)
                                         throws LBException
Returns coded node set for usage context entities.

Parameters:
codingSchemeNameOrURI - usage context coding scheme name or uri
versionOrTag - usage context coding scheme version or tag
Returns:
codedNodeSet of usage context entities
Throws:
LBException

listAllUsageContextEntities

java.util.List<Entity> listAllUsageContextEntities(java.lang.String codingSchemeNameOrURI,
                                                   CodingSchemeVersionOrTag versionOrTag)
                                                   throws LBException
Gets all the usage context found in the system as entities.

Parameters:
codingSchemeNameOrURI - usage context coding scheme name or uri
versionOrTag - usage context coding scheme version or tag
Returns:
List of usage context entities
Throws:
LBException

listAllUsageContextIds

java.util.List<java.lang.String> listAllUsageContextIds(java.lang.String codingSchemeNameOrURI,
                                                        CodingSchemeVersionOrTag versionOrTag)
                                                        throws LBException
Returns all the usage context identifiers found in the system.

Parameters:
codingSchemeNameOrURI - usage context coding scheme name or uri
versionOrTag - usage context coding scheme version or tag
Returns:
List of usage context identifiers
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.