org.LexGrid.LexBIG.cagrid.interfaces
Interface LexBIGServiceGrid

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

public interface LexBIGServiceGrid
extends java.io.Serializable

This interface represents the core interface to a LexBIG service.


Method Summary
 CodedNodeSetGrid getCodingSchemeConcepts(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Returns the set of all (or all active) concepts in the specified coding scheme.
 org.LexGrid.LexBIG.Extensions.Query.Filter getFilter(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
          Returns an instance of the filter extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getFilterExtensions()
          Returns a description of all registered extensions used to provide additional filtering of query results.
 org.LexGrid.LexBIG.Extensions.Generic.GenericExtension getGenericExtension(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
          Returns an instance of the application-specific extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getGenericExtensions()
          Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.
 HistoryServiceGrid getHistoryService(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification 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.
 org.LexGrid.LexBIG.DataModel.Collections.ModuleDescriptionList getMatchAlgorithms()
          Returns the full description of all supported match algorithms.
 CodedNodeGraphGrid getNodeGraph(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.RelationContainerIdentification relationsName)
          Returns the node graph as represented in the particular relationship set in the coding scheme.
 LexBIGServiceMetadataGrid<?> getServiceMetadata()
          Return an interface to perform system-wide query over metadata for loaded code systems and providers.
 org.LexGrid.LexBIG.Extensions.Query.Sort getSortAlgorithm(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
          Returns an instance of the sort extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList getSortAlgorithms(org.LexGrid.LexBIG.DataModel.InterfaceElements.types.SortContext context)
          Returns a description of all registered extensions used to provide additional sorting of query results in the given context.
 org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList getSupportedCodingSchemes()
          Return a list of coding schemes and versions that are supported by this service, along with their status.
 org.LexGrid.codingSchemes.CodingScheme resolveCodingScheme(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return detailed coding scheme information given a specific tag or version identifier.
 org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight resolveCodingSchemeCopyright(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return coding scheme copyright given a specific tag or version identifier.
 LexBIGServiceGrid setSecurityToken(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, gov.nih.nci.evs.security.SecurityToken token)
          Registers a Security Token for a coding scheme
 

Method Detail

getCodingSchemeConcepts

CodedNodeSetGrid getCodingSchemeConcepts(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                         org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                         throws LBException,
                                                java.rmi.RemoteException
Returns the set of all (or all active) concepts in the specified coding scheme.

Parameters:
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.
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

getFilter

org.LexGrid.LexBIG.Extensions.Query.Filter getFilter(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
                                                     throws java.rmi.RemoteException
Returns an instance of the filter extension registered with the given name.

Parameters:
name - The extension name; not null.
Returns:
org.LexGrid.LexBIG.Extensions.Query.Filter
Throws:
java.rmi.RemoteException

getFilterExtensions

org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getFilterExtensions()
                                                                                      throws java.rmi.RemoteException
Returns a description of all registered extensions used to provide additional filtering of query results.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Filter and providing a public parameterless constructor.
Throws:
java.rmi.RemoteException

getGenericExtension

org.LexGrid.LexBIG.Extensions.Generic.GenericExtension getGenericExtension(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
                                                                           throws LBException,
                                                                                  java.rmi.RemoteException
Returns an instance of the application-specific extension registered with the given name.

Parameters:
name - The extension name; not null.
Returns:
org.LexGrid.LexBIG.Extensions.Generic.GenericExtension
Throws:
LBException
java.rmi.RemoteException

getGenericExtensions

org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getGenericExtensions()
                                                                                       throws java.rmi.RemoteException
Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.

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).

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Generic.GenericExtension and providing a public parameterless constructor.
Throws:
LBException, - RemoteException
java.rmi.RemoteException

getHistoryService

HistoryServiceGrid getHistoryService(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme)
                                     throws LBException,
                                            java.rmi.RemoteException
Resolve a reference to the history api servicing the given coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
Returns:
org.LexGrid.LexBIG.History.HistoryService
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

getLastUpdateTime

java.util.Date getLastUpdateTime()
                                 throws LBInvocationException,
                                        java.rmi.RemoteException
Return the last time that the content of this service was changed; null if no changes have occurred. Tag assignments do not count as service changes for this purpose.

Returns:
java.util.Date
Throws:
LBInvocationException, - RemoteException
LBInvocationException
java.rmi.RemoteException

getMatchAlgorithms

org.LexGrid.LexBIG.DataModel.Collections.ModuleDescriptionList getMatchAlgorithms()
                                                                                  throws java.rmi.RemoteException
Returns the full description of all supported match algorithms.

Throws:
java.rmi.RemoteException

getNodeGraph

CodedNodeGraphGrid getNodeGraph(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                org.LexGrid.LexBIG.DataModel.cagrid.RelationContainerIdentification relationsName)
                                throws LBException,
                                       java.rmi.RemoteException
Returns the node graph as represented in the particular relationship set in the coding scheme.

Parameters:
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.
relationsName - 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.
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

getServiceMetadata

LexBIGServiceMetadataGrid<?> getServiceMetadata()
                                                throws LBException,
                                                       java.rmi.RemoteException
Return an interface to perform system-wide query over metadata for loaded code systems and providers.

Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

getSortAlgorithm

org.LexGrid.LexBIG.Extensions.Query.Sort getSortAlgorithm(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
                                                          throws LBException,
                                                                 java.rmi.RemoteException
Returns an instance of the sort extension registered with the given name.

Parameters:
name - The extension name; not null.
Returns:
org.LexGrid.LexBIG.Extensions.Query.Sort
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

getSortAlgorithms

org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList getSortAlgorithms(org.LexGrid.LexBIG.DataModel.InterfaceElements.types.SortContext context)
                                                                               throws java.rmi.RemoteException
Returns a description of all registered extensions used to provide additional sorting of query results in the given context.

Note: The returned list will include any 'built-in' sort algorithms in addition to extensions externally packaged and registered to the service.

Parameters:
context - A context defined by the SortContext class, or null to indicate that all registered algorithms are to be returned.
Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Sort and providing a public parameterless constructor.
Throws:
java.rmi.RemoteException

getSupportedCodingSchemes

org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList getSupportedCodingSchemes()
                                                                                             throws LBInvocationException,
                                                                                                    java.rmi.RemoteException
Return a list of coding schemes and versions that are supported by this service, along with their status.

Throws:
LBInvocationException, - RemoteException
LBInvocationException
java.rmi.RemoteException

resolveCodingScheme

org.LexGrid.codingSchemes.CodingScheme resolveCodingScheme(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                           org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                           throws LBException,
                                                                  java.rmi.RemoteException
Return detailed coding scheme information given a specific tag or version identifier.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the scheme to resolve.
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

resolveCodingSchemeCopyright

org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight resolveCodingSchemeCopyright(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                       org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                       throws LBException,
                                                                                              java.rmi.RemoteException
Return coding scheme copyright given a specific tag or version identifier.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the scheme to resolve.
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException

setSecurityToken

LexBIGServiceGrid setSecurityToken(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                   gov.nih.nci.evs.security.SecurityToken token)
                                   throws LBException,
                                          java.rmi.RemoteException
Registers a Security Token for a coding scheme

Parameters:
codingScheme - The local name or URN of the coding scheme.
token - The assigned security token.
Throws:
LBException, - RemoteException
LBException
java.rmi.RemoteException