org.lexevs.dao.database.service.valuesets
Interface ValueSetDefinitionService

All Known Implementing Classes:
VersionableEventValueSetDefinitionService

public interface ValueSetDefinitionService

The Interface ValueSetDefinitionService.

Author:
Kevin Peterson

Method Summary
 java.util.List<java.lang.String> getAllValueSetDefinitionsWithNoName()
          Return the URI's of all unnamed value set definition(s).
 ValueSetDefinition getValueSetDefinitionByDate(java.lang.String valueSetDefURI, java.sql.Date date)
           
 ValueSetDefinition getValueSetDefinitionByRevision(java.lang.String valueSetDefURI, java.lang.String revisionId)
           
 ValueSetDefinition getValueSetDefinitionByUri(java.net.URI uri)
          Gets the value set definition by uri.
 java.util.List<java.lang.String> getValueSetDefinitionURIForSupportedTagAndValue(java.lang.String supportedTag, java.lang.String value, java.lang.String uri)
          Returns list of Value Set Definition URIs that contain supplied SupportedAttribute Tag and Value.
 java.util.List<java.lang.String> getValueSetDefinitionURISForName(java.lang.String valueSetDefinitionName)
          Return all value set definition URIs that match the supplied key
 void insertDefinitionEntry(ValueSetDefinition valueSetDefinition, DefinitionEntry definitionEntry)
          Insert value set definition Entry.
 void insertDependentChanges(ValueSetDefinition valueSetDefinition)
           
 void insertValueSetDefinition(ValueSetDefinition definition, java.lang.String systemReleaseUri, Mappings mappings)
          Insert value set definition into the system.
 void insertValueSetDefinitions(ValueSetDefinitions valueSetDefinitions, java.lang.String systemReleaseUri)
          Insert value set definitions.
 java.util.List<java.lang.String> listValueSetDefinitionURIs()
          Lists all the value set definition URIs that are loaded in the system.
 void removeValueSetDefinition(java.lang.String valueSetDefinitionURI)
          Delete value set definition by value set definition URI.
 void revise(ValueSetDefinition valueSetDefinition, Mappings mapping, java.lang.String releaseURI)
           
 void updateValueSetDefinition(ValueSetDefinition valueSetDefinition)
           
 void updateVersionableAttributes(ValueSetDefinition valueSetDefinition)
           
 

Method Detail

insertValueSetDefinition

void insertValueSetDefinition(ValueSetDefinition definition,
                              java.lang.String systemReleaseUri,
                              Mappings mappings)
                              throws LBException
Insert value set definition into the system.

Parameters:
definition - the definition
systemReleaseUri - the system release uri
mappings - Supported Attribute mappings to be applied to the value set definition
Throws:
LBException

insertValueSetDefinitions

void insertValueSetDefinitions(ValueSetDefinitions valueSetDefinitions,
                               java.lang.String systemReleaseUri)
                               throws LBException
Insert value set definitions.

Parameters:
valueSetDefinitions - the value set definitions
systemReleaseUri - the system release uri
Throws:
LBException

insertDefinitionEntry

void insertDefinitionEntry(ValueSetDefinition valueSetDefinition,
                           DefinitionEntry definitionEntry)
                           throws LBException
Insert value set definition Entry.

Parameters:
valueSetDefinition - the value set definition the definition belongs to.
definitionEntry - the definition entry itself
Throws:
LBException

getValueSetDefinitionURISForName

java.util.List<java.lang.String> getValueSetDefinitionURISForName(java.lang.String valueSetDefinitionName)
                                                                  throws LBException
Return all value set definition URIs that match the supplied key

Parameters:
key - - null: return all value set definition URI's - " ": return all value set definition URI's with no name - otherwise return all URIs that match the key
Returns:
list of matching URIs
Throws:
LBException

getValueSetDefinitionByUri

ValueSetDefinition getValueSetDefinitionByUri(java.net.URI uri)
Gets the value set definition by uri.

Parameters:
uri - the uri
Returns:
the value set definition

getValueSetDefinitionURIForSupportedTagAndValue

java.util.List<java.lang.String> getValueSetDefinitionURIForSupportedTagAndValue(java.lang.String supportedTag,
                                                                                 java.lang.String value,
                                                                                 java.lang.String uri)
Returns list of Value Set Definition URIs that contain supplied SupportedAttribute Tag and Value.

Parameters:
supportedTag - SupportedAttribute tag like SupportedCodingScheme, SupportedConceptDomain etc.
value - value of the supportedAttribute
uri -
Returns:
list of URIs

listValueSetDefinitionURIs

java.util.List<java.lang.String> listValueSetDefinitionURIs()
Lists all the value set definition URIs that are loaded in the system.

Returns:
list of value set definition URIs

getAllValueSetDefinitionsWithNoName

java.util.List<java.lang.String> getAllValueSetDefinitionsWithNoName()
                                                                     throws LBException
Return the URI's of all unnamed value set definition(s).

Returns:
value set definition URI's
Throws:
LBException

removeValueSetDefinition

void removeValueSetDefinition(java.lang.String valueSetDefinitionURI)
Delete value set definition by value set definition URI.

Parameters:
valuesetdefinitionURI - the value set definition URI

updateValueSetDefinition

void updateValueSetDefinition(ValueSetDefinition valueSetDefinition)
                              throws LBException
Throws:
LBException

insertDependentChanges

void insertDependentChanges(ValueSetDefinition valueSetDefinition)
                            throws LBException
Throws:
LBException

updateVersionableAttributes

void updateVersionableAttributes(ValueSetDefinition valueSetDefinition)
                                 throws LBException
Throws:
LBException

revise

void revise(ValueSetDefinition valueSetDefinition,
            Mappings mapping,
            java.lang.String releaseURI)
            throws LBException
Throws:
LBException

getValueSetDefinitionByRevision

ValueSetDefinition getValueSetDefinitionByRevision(java.lang.String valueSetDefURI,
                                                   java.lang.String revisionId)
                                                   throws LBRevisionException
Throws:
LBRevisionException

getValueSetDefinitionByDate

ValueSetDefinition getValueSetDefinitionByDate(java.lang.String valueSetDefURI,
                                               java.sql.Date date)
                                               throws LBRevisionException
Throws:
LBRevisionException

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.