org.LexGrid.LexBIG.cagrid.LexEVSGridService.common
Interface LexEVSGridServiceI

All Known Implementing Classes:
LexEVSGridServiceClient

public interface LexEVSGridServiceI

This class is autogenerated, DO NOT EDIT. This interface represents the API which is accessable on the grid service from the client.


Method Summary
 CodedNodeSetClient getCodingSchemeConcepts(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Returns the set of all (or all active) concepts in the specified coding scheme.
 FilterClient getFilter(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification extensionIdentification)
          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.
 LexBIGServiceConvenienceMethodsClient getGenericExtension(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification extensionIdentification)
          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.
 HistoryServiceClient getHistoryService(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification)
          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.
 org.oasis.wsrf.properties.GetMultipleResourcePropertiesResponse getMultipleResourceProperties(org.oasis.wsrf.properties.GetMultipleResourceProperties_Element params)
           
 CodedNodeGraphClient getNodeGraph(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.RelationContainerIdentification relationContainerIdentification)
          Returns the node graph as represented in the particular relationship set in the coding scheme.
 org.oasis.wsrf.properties.GetResourcePropertyResponse getResourceProperty(javax.xml.namespace.QName params)
           
 LexBIGServiceMetadataClient getServiceMetadata()
          Return an interface to perform system-wide query over metadata for loaded code systems and providers.
 SortClient getSortAlgorithm(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification extensionIdentification)
          Returns an instance of the sort extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList getSortAlgorithms(java.lang.String 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.oasis.wsrf.properties.QueryResourcePropertiesResponse queryResourceProperties(org.oasis.wsrf.properties.QueryResourceProperties_Element params)
           
 org.LexGrid.codingSchemes.CodingScheme resolveCodingScheme(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification, 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 codingSchemeIdentification, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return coding scheme copyright given a specific tag or version identifier.
 LexEVSGridServiceClient setSecurityToken(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification, gov.nih.nci.evs.security.SecurityToken securityToken)
          Sets the Security Token for the given Coding Scheme.
 

Method Detail

getSupportedCodingSchemes

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

Throws:
LBInvocationException
java.rmi.RemoteException

getCodingSchemeConcepts

CodedNodeSetClient getCodingSchemeConcepts(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification,
                                           org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                           throws java.rmi.RemoteException,
                                                  org.apache.axis.types.URI.MalformedURIException,
                                                  LBException
Returns the set of all (or all active) concepts in the specified coding scheme.

Parameters:
codingSchemeIdentification -
versionOrTag -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

getLastUpdateTime

java.util.Date getLastUpdateTime()
                                 throws java.rmi.RemoteException,
                                        LBInvocationException
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.

Throws:
LBInvocationException
java.rmi.RemoteException

resolveCodingScheme

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

Parameters:
codingSchemeIdentification -
versionOrTag -
Throws:
LBException
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

CodedNodeGraphClient getNodeGraph(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification,
                                  org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                  org.LexGrid.LexBIG.DataModel.cagrid.RelationContainerIdentification relationContainerIdentification)
                                  throws java.rmi.RemoteException,
                                         org.apache.axis.types.URI.MalformedURIException,
                                         LBException
Returns the node graph as represented in the particular relationship set in the coding scheme.

Parameters:
codingSchemeIdentification -
versionOrTag -
relationContainerIdentification -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

getSortAlgorithms

org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList getSortAlgorithms(java.lang.String 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 -
Throws:
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).

Throws:
java.rmi.RemoteException

getGenericExtension

LexBIGServiceConvenienceMethodsClient getGenericExtension(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification extensionIdentification)
                                                          throws java.rmi.RemoteException,
                                                                 org.apache.axis.types.URI.MalformedURIException,
                                                                 LBException
Returns an instance of the application-specific extension registered with the given name.

Parameters:
extensionIdentification -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

getMultipleResourceProperties

org.oasis.wsrf.properties.GetMultipleResourcePropertiesResponse getMultipleResourceProperties(org.oasis.wsrf.properties.GetMultipleResourceProperties_Element params)
                                                                                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getResourceProperty

org.oasis.wsrf.properties.GetResourcePropertyResponse getResourceProperty(javax.xml.namespace.QName params)
                                                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

queryResourceProperties

org.oasis.wsrf.properties.QueryResourcePropertiesResponse queryResourceProperties(org.oasis.wsrf.properties.QueryResourceProperties_Element params)
                                                                                  throws java.rmi.RemoteException
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.

Throws:
java.rmi.RemoteException

getHistoryService

HistoryServiceClient getHistoryService(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification)
                                       throws java.rmi.RemoteException,
                                              org.apache.axis.types.URI.MalformedURIException,
                                              LBException
Resolve a reference to the history api servicing the given coding scheme.

Parameters:
codingSchemeIdentification -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

getServiceMetadata

LexBIGServiceMetadataClient getServiceMetadata()
                                               throws java.rmi.RemoteException,
                                                      org.apache.axis.types.URI.MalformedURIException,
                                                      LBException
Return an interface to perform system-wide query over metadata for loaded code systems and providers.

Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

getSortAlgorithm

SortClient getSortAlgorithm(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification extensionIdentification)
                            throws java.rmi.RemoteException,
                                   org.apache.axis.types.URI.MalformedURIException,
                                   LBException
Returns an instance of the sort extension registered with the given name.

Parameters:
extensionIdentification -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

getFilter

FilterClient getFilter(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification extensionIdentification)
                       throws java.rmi.RemoteException,
                              org.apache.axis.types.URI.MalformedURIException,
                              LBException
Returns an instance of the filter extension registered with the given name.

Parameters:
extensionIdentification -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException

resolveCodingSchemeCopyright

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

Parameters:
codingSchemeIdentification -
versionOrTag -
Throws:
LBException
java.rmi.RemoteException

setSecurityToken

LexEVSGridServiceClient setSecurityToken(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingSchemeIdentification,
                                         gov.nih.nci.evs.security.SecurityToken securityToken)
                                         throws java.rmi.RemoteException,
                                                org.apache.axis.types.URI.MalformedURIException,
                                                LBException
Sets the Security Token for the given Coding Scheme.

Parameters:
codingSchemeIdentification -
securityToken -
Throws:
LBException
java.rmi.RemoteException
org.apache.axis.types.URI.MalformedURIException