org.lexevs.dao.database.service.version
Interface AuthoringService

All Known Implementing Classes:
VersionableEventAuthoringService

public interface AuthoringService

The Interface VersionService.

Author:
Ramachandra Rao (Satya), Kevin Peterson

Method Summary
 SystemRelease getSystemReleaseMetadataById(java.lang.String systemReleaseId)
          get system release entry for a given unique id.
 SystemRelease getSystemReleaseMetadataByUri(java.lang.String systemReleaseUri)
          get system release entry for a given uri.
 java.lang.String insertSystemReleaseMetadata(SystemRelease systemRelease)
          insert system release entry.
 void loadRevision(Revision revision, java.lang.String systemReleaseURI, java.lang.Boolean indexNewCodingScheme)
          Method Loads the revision of an entry point object in lexEVS system.
 void loadRevision(Versionable versionable, java.lang.String releaseURI, java.lang.Boolean indexNewCodingScheme)
          Method Loads an entry point versionable object by wrapping it into a revision.
 void loadSystemRelease(SystemRelease systemRelease, java.lang.Boolean indexNewCodingScheme)
          Load system release.
 boolean removeRevisionRecordbyId(java.lang.String revisionId)
          removes revision record if not referenced by any existing entries.
 

Method Detail

loadSystemRelease

void loadSystemRelease(SystemRelease systemRelease,
                       java.lang.Boolean indexNewCodingScheme)
                       throws LBRevisionException
Load system release. A systemRelease can contain a codingScheme, valueSet, pickList and/or revision objects. All codingScheme, valueSet and pickLists loaded outside revision are wrapped under a system generated revision object.

Parameters:
systemRelease -
indexNewCodingScheme -
Throws:
LBRevisionException

loadRevision

void loadRevision(Revision revision,
                  java.lang.String systemReleaseURI,
                  java.lang.Boolean indexNewCodingScheme)
                  throws LBRevisionException
Method Loads the revision of an entry point object in lexEVS system. Revision will be validated for proper syntax and sequence before loading. If invalid, LBRevisionException is thrown. Entry point objects in lexEVS system are CodingScheme, ValueSet and PickList. A revision can contain single or multiple instances of one or all of the entry point objects. ChangedEntries are loaded by ascending order of relativeOrder.

Parameters:
revision - - revision object to be applied.
systemReleaseURI - - URI of the systemRelease (if any)
indexNewCodingScheme - - Boolean value to indicate if the any newly loaded codingScheme in this revision needs to Lucene indexed or not.
Throws:
LBRevisionException

loadRevision

void loadRevision(Versionable versionable,
                  java.lang.String releaseURI,
                  java.lang.Boolean indexNewCodingScheme)
                  throws LBRevisionException
Method Loads an entry point versionable object by wrapping it into a revision. Revision will be validated for proper syntax and sequence before loading. If invalid, LBRevisionException is thrown. Entry point objects in lexEVS system are CodingScheme, ValueSet and PickList.

Parameters:
versionable -
releaseURI - - URI of the systemRelease (if any)
indexNewCodingScheme - - Boolean value to indicate if the any newly loaded codingScheme in this revision needs to Lucene indexed or not.
Throws:
LBRevisionException

insertSystemReleaseMetadata

java.lang.String insertSystemReleaseMetadata(SystemRelease systemRelease)
insert system release entry.

Parameters:
systemRelease -

getSystemReleaseMetadataByUri

SystemRelease getSystemReleaseMetadataByUri(java.lang.String systemReleaseUri)
get system release entry for a given uri.

Parameters:
systemReleaseUri -
Returns:

getSystemReleaseMetadataById

SystemRelease getSystemReleaseMetadataById(java.lang.String systemReleaseId)
get system release entry for a given unique id.

Parameters:
systemReleaseId -
Returns:

removeRevisionRecordbyId

boolean removeRevisionRecordbyId(java.lang.String revisionId)
                                 throws LBException
removes revision record if not referenced by any existing entries.

Parameters:
revisionId - to be removed
Returns:
true if removed successfully
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.