org.LexGrid.LexBIG.LexBIGService
Interface LexBIGServiceManager

All Superinterfaces:
java.io.Serializable

public interface LexBIGServiceManager
extends java.io.Serializable

The service manager provides a single write and update access point for all of a service's content. The service manager allows new coding schemes to be validated and loaded, existing coding schemes to be retired and removed and the status of various coding schemes to be updated and changed.


Method Summary
 void activateCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion)
          Activate an inactive coding scheme version.
 void deactivateCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion, java.util.Date deactivateDate)
          Mark a coding scheme as inactive.
 Exporter getExporter(java.lang.String name)
          Return an instance of the named export extension.
 ExtensionDescriptionList getExportExtensions()
          Returns a description of all registered extensions used to export information loaded to a LexBIGService.
 ExtensionRegistry getExtensionRegistry()
          Returns the object used to manage all externally registered extensions to this service.
 Index getIndex(java.lang.String name)
          Return an instance of the named index extension.
 ExtensionDescriptionList getIndexExtensions()
          Return a list of registered index extensions supported by this service; empty if none are defined.
 Loader getLoader(java.lang.String name)
          Return an instance of the named loader extension.
 ExtensionDescriptionList getLoadExtensions()
          Returns a description of all registered extensions used to load information for access by a LexBIGService.
 void removeCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion)
          Remove a pending or inactive coding scheme from the service.
 void removeCodingSchemeVersionMetaData(AbsoluteCodingSchemeVersionReference codingSchemeVersion)
          Remove the metadata for a coding scheme from the service.
 void removeHistoryService(java.lang.String codingScheme)
          Remove pending or inactive coding scheme history information.
 void setVersionTag(AbsoluteCodingSchemeVersionReference codingSchemeVersion, java.lang.String tag)
          Assign a symbolic tag to a specified coding scheme version.
 

Method Detail

activateCodingSchemeVersion

void activateCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion)
                                 throws LBException
Activate an inactive coding scheme version.

Parameters:
codingSchemeVersion - The absolute version identifier for the coding scheme to activate; not null.
Throws:
LBException

deactivateCodingSchemeVersion

void deactivateCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion,
                                   java.util.Date deactivateDate)
                                   throws LBException
Mark a coding scheme as inactive.

Parameters:
codingSchemeVersion - The absolute version identifier for the coding scheme to deactivate; not null.
deactivateDate - Date/Time to deactivate the coding scheme.
Throws:
LBException

getExtensionRegistry

ExtensionRegistry getExtensionRegistry()
Returns the object used to manage all externally registered extensions to this service.


getExporter

Exporter getExporter(java.lang.String name)
                     throws LBException
Return an instance of the named export extension.

Parameters:
name - Name of the extension to return.
Throws:
LBException

getExportExtensions

ExtensionDescriptionList getExportExtensions()
Returns a description of all registered extensions used to export information loaded to a LexBIGService.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Export.Exporter and providing a public parameterless constructor.

getIndex

Index getIndex(java.lang.String name)
               throws LBException
Return an instance of the named index extension.

Note that the service may build required or default indices during load operations. Because these indices are required and automatically generated, they are not considered to be extensions and are therefore not reported through this method.

Parameters:
name - Name of the extension to return.
Throws:
LBException

getIndexExtensions

ExtensionDescriptionList getIndexExtensions()
Return a list of registered index extensions supported by this service; empty if none are defined.

Note that the service may build required or default indices during load operations. Because these indices are required and automatically generated, they are not considered to be extensions and are therefore not reported through this method.

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

getLoader

Loader getLoader(java.lang.String name)
                 throws LBException
Return an instance of the named loader extension.

Parameters:
name - Name of the extension to return.
Throws:
LBException

getLoadExtensions

ExtensionDescriptionList getLoadExtensions()
Returns a description of all registered extensions used to load information for access by a LexBIGService.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Load.Loader and providing a public parameterless constructor.

removeCodingSchemeVersion

void removeCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion)
                               throws LBException
Remove a pending or inactive coding scheme from the service.

Parameters:
codingSchemeVersion - The absolute version identifier of the coding scheme to remove.
Throws:
LBException

removeCodingSchemeVersionMetaData

void removeCodingSchemeVersionMetaData(AbsoluteCodingSchemeVersionReference codingSchemeVersion)
                                       throws LBException
Remove the metadata for a coding scheme from the service.

Parameters:
codingSchemeVersion - The absolute version identifier of the coding scheme to remove.
Throws:
LBException

removeHistoryService

void removeHistoryService(java.lang.String codingScheme)
                          throws LBException
Remove pending or inactive coding scheme history information.

Parameters:
codingScheme - The local name or URN of the coding scheme.
Throws:
LBException

setVersionTag

void setVersionTag(AbsoluteCodingSchemeVersionReference codingSchemeVersion,
                   java.lang.String tag)
                   throws LBException
Assign a symbolic tag to a specified coding scheme version.

Parameters:
codingSchemeVersion - The absolute version identifier of the coding scheme to set the tag on.
tag - Tag or label to assign to the given version; if null any existing tag is cleared.
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.