NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 3

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

compared with

New Version 4

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following table summarizes the operations available through the LexEVS Analytical Grid Service. Each of the operations is also defined in detail below. The grid analytical service and related operations are viewable via the caGrid Portal (http://cagrid-portal.nci.nih.govImage Removed).

ISO 21090 Model

The LexEVS 6.0 Analytical Grid Services use a version of the LexGRID/LexBIG model, extended to support ISO 21090 Datatypes.

The Click the adapted model may be found herelink.

Using the API

There are two (2) different interfaces for accessing the LexEVS Grid Services:

  1. org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter, or
  2. org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter
  • Option 1, org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter provides an interface for interacting with the LexEVS Grid Services. This Interface is intended to mirror the existing LexEVS API as much as possible. There is no object wrapping for semantic purposes on this interface. This allows existing applications of the LexEVS API to use Grid Services without code changes.
    This Interface may be acquired by instantiating LexBIGServiceAdapter with the Grid Service URL as a parameter.
    Code Block
    LexBIGService lbs = new LexBIGServiceAdapter
("http://lexevsapi-analytical60.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService");
  • Option 2, org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter also provides an interface for interacting with the LexEVS Grid Services. However, this Interfaces is the semantically defined interface. All method parameters and return values are defined and annotated as CDEs to be loaded into caDSR. This Interface is intended to be caGrid Silver Level Compliant.
    This Interface may be acquired by instantiating LexBIGServiceGridAdapter with the Grid Service URL as a parameter.
    Code Block
    LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter
("http://lexevsapi-analytical60.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService");

Method Descriptions

getCodingSchemeConcepts

getCodingSchemeConcepts(CodingSchemeIdentification, CodingSchemeVersionOrTag)

Description:

Returns the set of all (or all active) concepts in the specified coding scheme.

Input:

org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag

Output:

org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.CodedNodeSet.stubs.types.CodedNodeSetReference

Exception:

RemoteException

Implementation Details:

...

Input:

Implementation:

Description:

Returns an instance of the filter extension registered with the given name.

  • Step 1: Create a Resource on the server and populate it with the requested org.LexGrid.LexBIG.
iso21090
  • LexBIGService.
DataModel.cagrid
  • CodedNodeSet.
ExtensionIdentificationorg.LexGrid

Output:

Description:

Returns an instance of the sort extension registered with the given name.

Input:

  • Step 2: Return the Client Reference to the user. This Reference has the above org.LexGrid.LexBIG.LexBIGService.CodedNodeSet as a Resource. An org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.
Filter.stubs.types.FilterReference

Exception:

RemoteException

Implementation Details:

getSortAlgorithm

  • service.CodedNodeSetClient object is built from the above Reference.
    Sample Call:
  • Step 1: Connect to the LexEVS caGrid Service using the
  • org.LexGrid.LexBIG.
iso21090
  • cagrid.
DataModel.cagrid.ExtensionIdentification

Output:

''
  • adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.cagrid.
LexBIGCaGridServices
  • adapters.
Sort
  • LexBIGServiceGridAdapter. stubs.types.SortReference''

    Exception:

    RemoteException

    Implementation Details:

    getFilterExtensions

    • Code Block
      
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
    • Step 2: Build a

    Description:

    Returns a description of all registered extensions used to provide additional filtering of query results.

    Input:

    none

    Output

    • org.LexGrid.LexBIG.iso21090.DataModel.
    Collections.ExtensionDescriptionList

    Exception:

    RemoteException

    Implementation Details:

    Implementation:

    Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.

    Sample Call:

    ...

    • Core.CodingSchemeVersionOrTag containing the Version information for the desired Coding Scheme.
      Code Block
      
CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");
    • Step 3: Build an org.LexGrid.LexBIG.

    ...

    • iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.
      Code Block
      
CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code);
    • Step 4: Invoke the LexBIG

    LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);

    ...

    • caGrid service as follows:

    ...

    • Code Block
      
CodedNodeSetGrid cns = lbs.

    ...

    • getCodingSchemeConcepts(codingScheme, csvt);

    ...

    •

    getServiceMetadata

    getFilter

    getFilter(ExtensionIdentification)

    Description:

    Returns an instance of the filter extension registered with the given name

    Description:

    Return an interface to perform system-wide query over metadata for loaded code systems and providers.

    Input: none

    org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification

    Output:

    org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.LexBIGServiceMetadataFilter.
    stubs.types.LexBIGServiceMetadataReferenceFilterReference

    Exception:

    RemoteException

    Implementation Details:

    Implementation:

    • Step 1: Create a Resource on the server and populate it with the requested org.LexGrid.LexBIG.Extensions.Query.

    ...

    • Filter.

    ...

    • Step 2: Return the

    ...

    • Client Reference to the user. This

    ...

    • Reference has the above org.LexGrid.LexBIG.Extensions.

    ...

    • Query.

    ...

    • Filter as a Resource.

    ...

    • This client is a Service Context that allows the user to call regular org.LexGrid.LexBIG.Extensions.Query.Filter API calls through the grid service. An org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.

    ...

    • Filter.client.

    ...

    • FilterClient object is built from the above Reference.

    ...

    Sample Call:'

    ...

    • This FilterClient implements the Interface org.LexGrid.LexBIG.

    ...

    • Extensions.Query.

    ...

    • Filter. This makes calling Grid Service Calls through org.LexGrid.LexBIG.cagrid.

    ...

    • LexBIGCaGridServices.Filter.client.FilterClient transparent to the end user.
      Sample Call:
    • Step 1: Connect to the LexEVS caGrid Service using the org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter.
      Code Block
      
LexBIGServiceGrid lbs = new

    ...

    • LexBIGServiceGridAdapter(url);
    • Step 2:

    ...

    • Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification to hold the Extension name.
      Code Block
      
ExtensionIdentification extension = new ExtensionIdentification(); extension.setLexBIGExtensionName(name);
    • Step 3: Invoke the LexEVS caGrid service as follows:
      Code Block
      
Filter filter = lbs.getFilter(extension);

    getSortAlgorithm

    getSortAlgorithm(ExtensionIdentification)

    Description:

    Returns an instance of the sort extension registered with the given name.

    Input:

    org

    LexBIGServiceMetadataGrid metadata = lbs.getServiceMetadata(); |

    getSupportedCodingSchemes

    Description:

    Return a list of coding schemes and versions that are supported by this service, along with their status.

    Input:

    none

    Output:

    org.LexGrid.LexBIG.iso21090.DataModel.Collections.CodingSchemeRenderingListcagrid.ExtensionIdentification

    Output:

    ''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.
    stubs.types.SortReference''

    Exception:

    RemoteException

    Implementation Details:

    Implementation:

    • Step 1:

    ...

    Sample Call:

    ...

    • Create a Resource on the server and populate it with the requested org.LexGrid.LexBIG.Extensions.Query.Sort
    • Step 2: Return the Client Reference to the user. This Reference has the above org.LexGrid.LexBIG.cagrid

    ...

    • .LexBIGCaGridServices.Sort.client.SortClient as a Resource. This client is a Service Context that allows the user to call regular org.LexGrid.LexBIG.

    ...

    • Extensions.

    ...

    • Query.Sort API calls through the grid service. An org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.client.SortClient object is built from the above Reference. This SortClient implements the Interface org.LexGrid.LexBIG.Extensions.Query.Sort. This makes calling Grid Service Calls through org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.client.SortClient transparent to the end user.
      Sample Call:
    • Step 1: Connect to the LexEVS

    LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);

    Step 2: Invoke the LexEVS caGrid service as follows:

    CodingSchemeRenderingList csrl = lbs.getSupportedCodingSchemes(); |

    getLastUpdateTime

    ...

    Description:

    ...

    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.

    ...

    Input:

    ...

    none

    ...

    Output:

    ...

    java.util.Date

    ...

    Exception:

    ...

    RemoteException

    ...

    Implementation Details:

    Implementation:

    Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.

    Sample Call:

    ...

    • caGrid Service using the org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter.
      Code Block
      
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
    • Step 2:

    ...

    • Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification to hold the Extension name.
      Code Block
      
ExtensionIdentification extension = new ExtensionIdentification(); extension.setLexBIGExtensionName(name);
    • Step 3: Invoke the LexEVS caGrid service as follows:
      Code Block
      
Filter filter = lbs.getSortAlgorithm(extension);

    getFilterExtensions

    getFilterExtensions()

    Description:

    Returns a description of all registered extensions used to provide additional filtering of query results.

    Input:

    none

    Output

    Date date = lbs.getLastUpdateTime(); |

    resolveCodingScheme

    Description:

    Return detailed coding scheme information given a specific tag or version identifier.

    Input:

    org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag

    Output:

    org.LexGrid.codingSchemes.CodingScheme

    Collections.ExtensionDescriptionList

    Exception:

    RemoteException

    Implementation Details:

    ...

    Input:

    Implementation:

    Description:

    Returns the node graph as represented in the particular relationship set in the coding scheme.

    Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
    Sample Call:

    • Step 1: Connect to the LexEVS caGrid Service using the
    • org.LexGrid.LexBIG
    .iso21090.DataModel
    • .cagrid.
    CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag,
    • adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.
    iso21090
    • cagrid.
    DataModel
    • adapters.
    cagrid
    • LexBIGServiceGridAdapter.
    RelationContainerIdentification

    • Output:

      ''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.
      CodedNodeGraph.stubs.types.CodedNodeGraphReference''

      Exception:

      RemoteException

      Implementation Details:

      getMatchAlgorithms

      ...

      Description:

      ...

      Returns the node graph as represented in the particular relationship set in the coding scheme.

      ...

      Input:

      ...

      none

      ...

      Output:

      ...

      org.LexGrid.LexBIG.iso21090.DataModel.Collections.ModuleDescriptionList

      ...

      Exception:

      ...

      RemoteException

      ...

      Implementation Details:

      • Code Block
         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2:_ Invoke the LexEVS caGrid service as follows:

         ExtensionDescriptionList extDescList = lbs.getFilterExtensions(); 
         Code Block
         |

h3. getServiceMetadata
{{getServiceMetadata()}}

| Description: | Return an interface to perform system-wide query over metadata for loaded code systems and providers. |
| Input: | _none_ |
| Output: | _
      Implementation:
      Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
      Sample Call:
      ...
      • org.LexGrid.LexBIG.cagrid.
      ...
      • LexBIGCaGridServices.
      ...
      LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
      Step 2: Invoke the LexEVS caGrid service as follows:
       ModuleDescriptionList mdl = lbs.getMatchAlgorithms(); |
      getGenericExtensions
      ...
       Description: 
      ...
       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). |
       Input: 
       none 
       Output: 
      • LexBIGServiceMetadata._
_stubs.types.LexBIGServiceMetadataReference_ |
| Exception: | _RemoteException_ |
| Implementation Details: | *_Implementation:_*
* _Step 1:_ Create a Resource on the server and populate it with the requested {{org.LexGrid.LexBIG.
      iso21090
      • LexBIGService.
      DataModel.Collections.ExtensionDescriptionList
       Exception: 
       RemoteException 
       Implementation Details: 
      Implementation:
      Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
      Sample Call:
      Step 1: Connect to the LexEVS caGrid Service using the org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter
      LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
      Step 2: Invoke the LexEVS caGrid service as follows:
       ExtensionDescriptionList edl = lbs.getGenericExtensions(); |
      getGenericExtension
      ...
       Description: 
      ...
       Returns an instance of the application-specific extension registered with the given name. 
      ...
       Input: 
      ...
       org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification 
      ...
       Output: 
      ...
       org.LexGrid.LexBIG.iso21090.DataModel.Collections.SortDescriptionList 
      ...
       Exception: 
      ...
       RemoteException 
      ...
       Implementation Details: 
      getHistoryService
      ...
       Description: 
      ...
       Resolve a reference to the history api servicing the given coding scheme. 
      ...
       Input: 
      ...
       org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification 
      ...
       Output: 
      ...
       org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.
       HistoryService.stubs.types.HistoryServiceReference 
      ...
       Exception: 
      ...
       RemoteException 
      ...
       Implementation Details: 
      • LexBIGServiceMetadata}}.
* _Step 2:_ Return the LexBIGServiceMetadataClient to the user. This LexBIGServiceMetadataClient has the above {{org.LexGrid.LexBIG.LexBIGService.LexBIGServiceMetadata}} as a Resource. An {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.LexBIGServiceMetadataClient}} object is built from the above Reference. |
| | *_Sample Call:_*'
* _Step 1:_ Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2:_ Invoke the LexEVS caGrid service as follows:

         LexBIGServiceMetadataGrid metadata = lbs.getServiceMetadata(); 
         Code Block
         |

h3. getSupportedCodingSchemes
{{getSupportedCodingSchemes()}}

| Description: | Return a list of coding schemes and versions that are supported by this service, along with their status. |
| Input: | _none_ |
| Output: | _org.LexGrid.LexBIG.iso21090.DataModel.Collections.CodingSchemeRenderingList_ |
| Exception: | _RemoteException_ |
| Implementation Details: | *_Implementation:_*
_Step 1:_ Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
*_Sample Call:_*
* _Step 1:_ Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2:_ Invoke the LexEVS caGrid service as follows:

         CodingSchemeRenderingList csrl = lbs.getSupportedCodingSchemes(); 
         Code Block
         |

h3. getLastUpdateTime
{{getLastUpdateTime()}}

| Description: | 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. |
| Input: | _none_ |
| Output: | _java.util.Date_ |
| Exception: | _RemoteException_ |
| Implementation Details: | *_Implementation:_*
_Step 1:_ Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
*_Sample Call:_*
* _Step 1:_ Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2:_ Invoke the LexEVS caGrid service as follows:

         Date date = lbs.getLastUpdateTime(); 
         Code Block
         |


h3. resolveCodingScheme
{{resolveCodingScheme(CodingSchemeIdentification, CodingSchemeVersionOrTag)}}

| Description: | Return detailed coding scheme information given a specific tag or version identifier. |
| Input: | _org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag_ |
| Output: | _org.LexGrid.codingSchemes.CodingScheme_ |
| Exception: | _RemoteException_ |
| Implementation Details: | _*Implementation*_:
_Step 1_: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
_*Sample Call*_:
* _Step 1_: Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2_: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.

         CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code); 
         Code Block
        
* _Step 3_: Build a {{org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag}} containing the Version information for the desired Coding Scheme.

         CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion"); 
         Code Block
        
* _Step 4_: Invoke the LexEVS caGrid service as follows: 

         CodedNodeSetGrid cns = lbs.resolveCodingScheme(codingScheme, csvt); 
         Code Block
         |


h3. getNodeGraph
{{getNodeGraph(CodingSchemeIdentification, CodingSchemeVersionOrTag, RelationContainerIdentification)}}

| Description: | Returns the node graph as represented in the particular relationship set in the coding scheme. |
| Input: | _org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag, org.LexGrid.LexBIG.iso21090.DataModel.cagrid.RelationContainerIdentification_ |
| Output: | ''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.
CodedNodeGraph.stubs.types.CodedNodeGraphReference'' |
| Exception: | _RemoteException_ |
| Implementation Details: | _*Implementation*_:
* _Step 1_: Create a Resource on the server and populate it with the requested {{org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph}}.
* _Step 2_: Return the Client Reference to the user. This Reference has the above {{org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph}} as a Resource. An {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.CodedNodeGraphClient}} object is built from the above Reference.
_*Sample Call*_:
* _Step 1_: Connect to the LexBIG caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2_: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.

         CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code); 
         Code Block
        
* _Step 3_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag}} containing the Version information for the desired Coding Scheme.

         CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion"); 
         Code Block
        
* _Step 4_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.cagrid.RelationContainerIdentification}} containing the Relation Container information.

         RelationContainerIdentification container = new RelationContainerIdentification(); container.setDc(name); 
         Code Block
        
* _Step 5_: Invoke the LexEVS caGrid service as follows, providing String parameters for the desired Coding Scheme and Relationship Name: 

         CodedNodeGraphGrid cng = client.getNodeGraph(codingScheme, csvt, container); 
         Code Block
         |


h3. getMatchAlgorithms
{{getMatchAlgorithms()}}

| Description: | Returns the node graph as represented in the particular relationship set in the coding scheme. |
| Input: | _none_ |
| Output: | _org.LexGrid.LexBIG.iso21090.DataModel.Collections.ModuleDescriptionList_ |
| Exception: | _RemoteException_ |
| Implementation Details: | *_Implementation:_*
* _Step 1:_ Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
*_Sample Call:_*
* _Step 1:_ Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2:_ Invoke the LexEVS caGrid service as follows:

         ModuleDescriptionList mdl = lbs.getMatchAlgorithms(); 
         Code Block
         |


h3. getGenericExtensions
{{getGenericExtensions()}}

| Description: | Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.
{info:title=Note}nly generic extensions (base class GenericExtension) will be listed here. All other classes are retrievable at the appropriate interface point (filter, sort, etc).{info} |
| Input: | _none_ |
| Output: | _org.LexGrid.LexBIG.iso21090.DataModel.Collections.ExtensionDescriptionList_ |
| Exception: | _RemoteException_ |
| Implementation Details: | *_Implementation:_*
_Step 1:_ Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
*_Sample Call:_*
* _Step 1:_ Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2:_ Invoke the LexEVS caGrid service as follows:

         ExtensionDescriptionList edl = lbs.getGenericExtensions(); 
         Code Block
          |


h3. getGenericExtension
{{getGenericExtensions(ExtensionIdentification)}}

| Description: | Returns an instance of the application-specific extension registered with the given name. |
| Input: | _org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification_ |
| Output: | _org.LexGrid.LexBIG.iso21090.DataModel.Collections.SortDescriptionList_ |
| Exception: | _RemoteException_ |
| Implementation Details: | _*Implementation*_:
_Step 1_: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
_*Sample Call*_:
* _Step 1_: Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
{info:title=Note}Currently this method will return a LexBIGServiceConvenienceMethods instance.{info}
* _Step 2_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification}} to hold the Extension name.

         ExtensionIdentification extension = new ExtensionIdentification(); extension.setLexBIGExtensionName("LexBIGServiceConvenienceMethods"); 
         Code Block
        
* _Step 3_: Invoke the LexEVS caGrid service as follows: 

         LexBIGServiceConvenienceMethodsGrid lbscm = lbs.getGenericExtensions(extension); 
         Code Block
        
* _Step 4_: Return the {{LexBIGServiceConvenienceMethodsClient}} to the user. This LexBIGServiceConvenienceMethodsClient has the above {{org.LexGrid.LexBIG.Extensions.Generic.LexBIGServiceConvenienceMethods}} as a Resource. An {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.CodedNodeGraphClient}} object is built from the above Reference. |


h3. getHistoryService
{{getHistoryService(CodingSchemeIdentification)}}

| Description: | Resolve a reference to the history api servicing the given coding scheme. |
| Input: | _org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification_ |
| Output: | _org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices._
_HistoryService.stubs.types.HistoryServiceReference_ |
| Exception: | _RemoteException_ |
| Implementation Details: | _*Implementation*_:
* _Step 1_: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
* _Step 2_: Return the HistoryServiceClient to the user. This HistoryServiceClient has the above {{org.LexGrid.LexBIG.History.HistoryService}} as a Resource. This Client is a Service Context that allows the user to call regular {{org.LexGrid.LexBIG.History.HistoryService}} API calls through the grid service. HistoryServiceClient implements the Interface {{org.LexGrid.LexBIG.History.HistoryServic}}e. This makes calling Grid Service Calls through {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.HistoryService.client.HistoryServiceClient}} transparent to the end user.
_*Sample Call*_:
* _Step 1_: Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification}} to hold the Coding Scheme name.

         CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code); 
         Code Block
        
* _Step 3_: Invoke the LexEVS caGrid service as follows: 

         HistoryServiceGrid history = lbs.getHistoryService(codingScheme); 
         Code Block
         |


h3. getSortAlgorithms
{{getSortAlgorithms(SortContext)}}

| Description: | Returns a description of all registered extensions used to provide additional filtering of query results. |
| Input: | _org.LexGrid.LexBIG.iso21090.DataModel.InterfaceElements.types.SortContext_ |
| Output: | _org.LexGrid.LexBIG.iso21090.DataModel.Collections.SortDescriptionList_ |
| Exception: | _RemoteException_ |
| Implementation Details: | _*Implementation*_:
_Step 1_: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
_*Sample Call*_:
* _Step 1_: Connect to the LexEVS caGrid Service using the org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2_: Invoke the LexEVS caGrid service as follows: 

         SortDescriptionList sortDescList = lbs.getSortAlgorithms(sortContext); 
         Code Block
         |


h3. resolveCodingSchemeCopyright
{{resolveCodingSchemeCopyright(CodingSchemeIdentification)}}

| Description: | Return coding scheme copyright given a specific tag or version identifier. |
| Input: | _org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification_ |
| Output: | _org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeCopyRight_ |
| Exception: | _RemoteException_ |
| Implementation Details: | _*Implementation*_:
_Step 1_: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
_*Sample Call*_:
* _Step 1_: Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}.

         LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); 
         Code Block
        
* _Step 2_: Build an {{
      getSortAlgorithms
       Description: 
       Returns a description of all registered extensions used to provide additional filtering of query results. 
       Input: 
      • org.LexGrid.LexBIG.iso21090.DataModel
      .InterfaceElements.types.SortContext
       Output: 
      • .cagrid.CodingSchemeIdentification}} to hold the Coding Scheme name.

         CodingSchemeIdentification codingScheme = new
      CodingSchemeIdentification();
      codingScheme.setCode(code);
       Code Block
      
* _Step 3_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.
      ...
       Exception: 
      ...
       RemoteException 
      ...
       Implementation Details: 
      Core.CodingSchemeVersionOrTag}} containing the Version information for the desired Coding Scheme.

      CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");
       Code Block
      
* _Step 4_: Invoke the LexEVS caGrid service as follows: 

      CodingSchemeCopyRight copyright = lbs.resolveCodingSchemeCopyright(codingScheme, csvt); 
       Code Block
       |
      resolveCodingSchemeCopyright
      ...
       Description: 
      ...
       Return coding scheme copyright given a specific tag or version identifier. 
      ...
       Input: 
      ...
       org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification 
      ...
       Output: 
      ...
       org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeCopyRight 
      ...
       Exception: 
      ...
       RemoteException 
      ...
      setSecurityToken
       Description: 
       Sets the Security Token for the given Coding Scheme. 
       Input: 
       org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, gov.nih.nci.evs.security.SecurityToken 
       Output: 
       org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LexEVSGridServiceReference.LexEVSGridServiceReference 
       Exception: 
       RemoteException 
       Implementation Details: 
      ...