public interface LexBIGServiceManager
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
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 |
registerCodingSchemeAsSupplement(AbsoluteCodingSchemeVersionReference parentCodingScheme,
AbsoluteCodingSchemeVersionReference supplementCodingScheme)
Register a coding scheme as a supplement to a specified coding scheme.
|
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.
|
void |
shutdown()
Shuts down LexBIG Services and all associated resources.
|
void |
unRegisterCodingSchemeAsSupplement(AbsoluteCodingSchemeVersionReference parentCodingScheme,
AbsoluteCodingSchemeVersionReference supplementCodingScheme)
Unregister a coding scheme as a supplement to a specified coding scheme.
|
void activateCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion) throws LBException
codingSchemeVersion
- The absolute version identifier for the coding scheme
to activate; not null.LBException
void deactivateCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion, java.util.Date deactivateDate) throws LBException
codingSchemeVersion
- The absolute version identifier for the coding scheme
to deactivate; not null.deactivateDate
- Date/Time to deactivate the coding scheme.LBException
ExtensionRegistry getExtensionRegistry()
Exporter getExporter(java.lang.String name) throws LBException
name
- Name of the extension to return.LBException
ExtensionDescriptionList getExportExtensions()
Index getIndex(java.lang.String name) throws LBException
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.
name
- Name of the extension to return.LBException
ExtensionDescriptionList getIndexExtensions()
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.
Loader getLoader(java.lang.String name) throws LBException
name
- Name of the extension to return.LBException
ExtensionDescriptionList getLoadExtensions()
void removeCodingSchemeVersion(AbsoluteCodingSchemeVersionReference codingSchemeVersion) throws LBException
codingSchemeVersion
- The absolute version identifier of the coding scheme to remove.LBException
void removeCodingSchemeVersionMetaData(AbsoluteCodingSchemeVersionReference codingSchemeVersion) throws LBException
codingSchemeVersion
- The absolute version identifier of the coding scheme to remove.LBException
void removeHistoryService(java.lang.String codingScheme) throws LBException
codingScheme
- The local name or URN of the coding scheme.LBException
void setVersionTag(AbsoluteCodingSchemeVersionReference codingSchemeVersion, java.lang.String tag) throws LBException
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.LBException
void registerCodingSchemeAsSupplement(AbsoluteCodingSchemeVersionReference parentCodingScheme, AbsoluteCodingSchemeVersionReference supplementCodingScheme) throws LBException
parentCodingScheme
- The coding scheme to which the supplement will be appliedsupplementCodingScheme
- The coding scheme to use as a supplementLBException
void unRegisterCodingSchemeAsSupplement(AbsoluteCodingSchemeVersionReference parentCodingScheme, AbsoluteCodingSchemeVersionReference supplementCodingScheme) throws LBException
parentCodingScheme
- The coding scheme to which the supplement was registeredsupplementCodingScheme
- The coding scheme supplement to be unregisteredLBException
void shutdown()