public interface LexBIGService
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
CodedNodeSet |
getCodingSchemeConcepts(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns the set of all concepts in the specified coding scheme.
|
CodedNodeSet |
getCodingSchemeConcepts(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
boolean activeOnly)
Deprecated.
Replaced by use of base getCodingSchemeConcepts() method and
use of the ActiveStatus restriction.
|
Filter |
getFilter(java.lang.String name)
Returns an instance of the filter extension registered with the given name.
|
ExtensionDescriptionList |
getFilterExtensions()
Returns a description of all registered extensions used to provide
additional filtering of query results.
|
GenericExtension |
getGenericExtension(java.lang.String name)
Returns an instance of the application-specific extension registered with
the given name.
|
ExtensionDescriptionList |
getGenericExtensions()
Returns a description of all registered extensions used to implement
application-specific behavior that is centrally accessible from a
LexBIGService.
|
HistoryService |
getHistoryService(java.lang.String codingScheme)
Resolve a reference to the history api servicing the given coding scheme.
|
java.util.Date |
getLastUpdateTime()
Return the last time that the content of this service was changed; null
if no changes have occurred.
|
ModuleDescriptionList |
getMatchAlgorithms()
Returns the full description of all supported match algorithms.
|
CodedNodeGraph |
getNodeGraph(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String relationContainerName)
Returns the node graph as represented in the particular relationship set
in the coding scheme.
|
CodedNodeSet |
getNodeSet(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
LocalNameList entityTypes)
Returns the set of all entities in the specified coding scheme
scheme of the given types.
|
LexBIGServiceManager |
getServiceManager(java.lang.Object credentials)
Validate the credentials and return an interface to the LexBig service
manager.
|
LexBIGServiceMetadata |
getServiceMetadata()
Return an interface to perform system-wide query over
metadata for loaded code systems and providers.
|
Sort |
getSortAlgorithm(java.lang.String name)
Returns an instance of the sort extension registered with the given name.
|
SortDescriptionList |
getSortAlgorithms(SortContext context)
Returns a description of all registered extensions used to provide
additional sorting of query results in the given context.
|
CodingSchemeRenderingList |
getSupportedCodingSchemes()
Return a list of coding schemes and versions that are supported by this
service, along with their status.
|
CodingScheme |
resolveCodingScheme(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return detailed coding scheme information given a specific tag or version
identifier.
|
java.lang.String |
resolveCodingSchemeCopyright(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return coding scheme copyright given a specific tag or version
identifier.
|
CodedNodeSet getCodingSchemeConcepts(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme to query.LBException
CodedNodeSet getCodingSchemeConcepts(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, boolean activeOnly) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme to query.activeOnly
- True means node set consists only of concepts that are active
in the given version. False means set represents both active
and inactive concepts.LBException
Filter getFilter(java.lang.String name) throws LBException
name
- The extension name; not null.LBException
ExtensionDescriptionList getFilterExtensions()
GenericExtension getGenericExtension(java.lang.String name) throws LBException
name
- The extension name; not null.LBException
ExtensionDescriptionList getGenericExtensions()
Note that only generic extensions (base class GenericExtension) will be listed here. All other classes are retrievable at the appropriate interface point (filter, sort, etc).
HistoryService getHistoryService(java.lang.String codingScheme) throws LBException
codingScheme
- The local name or URN of the coding scheme.LBException
java.util.Date getLastUpdateTime() throws LBInvocationException
LBInvocationException
ModuleDescriptionList getMatchAlgorithms()
CodedNodeGraph getNodeGraph(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String relationContainerName) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme to query.relationContainerName
- The name of the relations container to reference when generating
the graph. If omitted, all native relation containers for the code
system will be queried. Note: a 'native' container contains a
set of associations defined by the coding scheme curators.LBException
CodedNodeSet getNodeSet(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme to query.entityTypes
- The list of entity types to resolve. Possible values
include the LexGrid built-in types "concept" and "instance".
Additional supported types can be defined uniquely to a
coding scheme. If null or empty, all entity types are
resolved.LBException
LexBIGServiceManager getServiceManager(java.lang.Object credentials) throws LBException
credentials
- Credentials - type to be determined by the security system;
null if not applicable.LBException
LexBIGServiceMetadata getServiceMetadata() throws LBException
LBException
Sort getSortAlgorithm(java.lang.String name) throws LBException
name
- The extension name; not null.LBException
SortDescriptionList getSortAlgorithms(SortContext context)
Note: The returned list will include any 'built-in' sort algorithms in addition to extensions externally packaged and registered to the service.
context
- A context defined by the SortContext class, or null to
indicate that all registered algorithms are to be returned.CodingSchemeRenderingList getSupportedCodingSchemes() throws LBInvocationException
LBInvocationException
CodingScheme resolveCodingScheme(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
scheme to resolve.LBException
java.lang.String resolveCodingSchemeCopyright(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
scheme to resolve.LBException