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

All Known Implementing Classes:
VersionableEventPickListDefinitionService

public interface PickListDefinitionService

The Interface PickListService.

Author:
Kevin Peterson

Method Summary
 PickListDefinition getPickListDefinitionByPickListId(java.lang.String pickListId)
          Gets the pick list definition by pick list id.
 java.util.List<java.lang.String> getPickListDefinitionIdForEntityReference(java.lang.String entityCode, java.lang.String entityCodeNameSpace, java.lang.String propertyId)
           
 java.util.List<java.lang.String> getPickListDefinitionIdForSupportedTagAndValue(java.lang.String supportedTag, java.lang.String value)
          Returns list of pick list definition IDs that contains supplied Supported Attribute Tag and Value.
 java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionUri(java.lang.String valueSetDefUri)
          Gets the pick list definition id's by value set definition uri.
 void insertDependentChanges(PickListDefinition definition)
           
 void insertPickListDefinition(PickListDefinition definition, java.lang.String systemReleaseUri, Mappings mappings)
          Insert pick list definition.
 void insertPickListDefinitions(PickListDefinitions definitions, java.lang.String systemReleaseUri)
          Insert pick list definitions.
 java.util.List<java.lang.String> listPickListIds()
          List pick list ids.
 void removePickListDefinition(PickListDefinition definition)
           
 void removePickListDefinitionByPickListId(java.lang.String pickListId)
          Removes the pick list definition by pick list id.
 PickListDefinition resolvePickListDefinitionByDate(java.lang.String pickListId, java.sql.Date date, java.lang.Integer sortType)
           
 PickListDefinition resolvePickListDefinitionByRevision(java.lang.String pickListId, java.lang.String revisionId, java.lang.Integer sortType)
           
 void revise(PickListDefinition pickListDefinition, Mappings mapping, java.lang.String releaseURI)
           
 void updatePickListDefinition(PickListDefinition definition)
           
 void updateVersionableAttributes(PickListDefinition definition)
           
 

Method Detail

getPickListDefinitionByPickListId

PickListDefinition getPickListDefinitionByPickListId(java.lang.String pickListId)
Gets the pick list definition by pick list id.

Parameters:
pickListId - the pick list id
Returns:
the pick list definition by pick list id

getPickListDefinitionIdForValueSetDefinitionUri

java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionUri(java.lang.String valueSetDefUri)
Gets the pick list definition id's by value set definition uri.

Parameters:
valueSetDefUri - the value set definition uri
Returns:
list of pick list definition id that match value set definition uri

getPickListDefinitionIdForEntityReference

java.util.List<java.lang.String> getPickListDefinitionIdForEntityReference(java.lang.String entityCode,
                                                                           java.lang.String entityCodeNameSpace,
                                                                           java.lang.String propertyId)
Parameters:
entityCode -
entityCodeNameSpace -
propertyId -
extractPickListName -
Returns:
Throws:
LBException

getPickListDefinitionIdForSupportedTagAndValue

java.util.List<java.lang.String> getPickListDefinitionIdForSupportedTagAndValue(java.lang.String supportedTag,
                                                                                java.lang.String value)
Returns list of pick list definition IDs that contains supplied Supported Attribute Tag and Value.

Parameters:
supportedTag - SupportedAttribute tag like SupportedCodingScheme, SupportedAssociation etc.
value - value of the supportedAttribute
Returns:
list of picklistIds

removePickListDefinitionByPickListId

void removePickListDefinitionByPickListId(java.lang.String pickListId)
Removes the pick list definition by pick list id.

Parameters:
pickListId - the pick list id

insertPickListDefinition

void insertPickListDefinition(PickListDefinition definition,
                              java.lang.String systemReleaseUri,
                              Mappings mappings)
                              throws LBParameterException,
                                     LBException
Insert pick list definition.

Parameters:
definition - the definition
systemReleaseUri - the system release uri
mappings - SupportedAttribute mappings of pick list definition
Throws:
LBParameterException
LBException

insertPickListDefinitions

void insertPickListDefinitions(PickListDefinitions definitions,
                               java.lang.String systemReleaseUri)
Insert pick list definitions.

Parameters:
definitions - the pick list definitions
systemReleaseUri - the system release uri

listPickListIds

java.util.List<java.lang.String> listPickListIds()
List pick list ids.

Returns:
the list< string>

updatePickListDefinition

void updatePickListDefinition(PickListDefinition definition)
                              throws LBException
Throws:
LBException

removePickListDefinition

void removePickListDefinition(PickListDefinition definition)

updateVersionableAttributes

void updateVersionableAttributes(PickListDefinition definition)
                                 throws LBException
Throws:
LBException

insertDependentChanges

void insertDependentChanges(PickListDefinition definition)
                            throws LBException
Throws:
LBException

revise

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

resolvePickListDefinitionByRevision

PickListDefinition resolvePickListDefinitionByRevision(java.lang.String pickListId,
                                                       java.lang.String revisionId,
                                                       java.lang.Integer sortType)
                                                       throws LBRevisionException
Throws:
LBRevisionException

resolvePickListDefinitionByDate

PickListDefinition resolvePickListDefinitionByDate(java.lang.String pickListId,
                                                   java.sql.Date date,
                                                   java.lang.Integer sortType)
                                                   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.