org.lexevs.dao.database.access.valuesets
Interface PickListDao

All Superinterfaces:
LexGridSchemaVersionAwareDao
All Known Implementing Classes:
IbatisPickListDao

public interface PickListDao
extends LexGridSchemaVersionAwareDao

The Interface PickListDao.

Author:
Kevin Peterson

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.lexevs.dao.database.access.LexGridSchemaVersionAwareDao
LexGridSchemaVersionAwareDao.IndividualDaoCallback<T>
 
Method Summary
 boolean entryStateExists(java.lang.String entryStateUId)
           
 java.lang.String getLatestRevision(java.lang.String pickListDefUId)
           
 PickListDefinition getPickListDefinitionById(java.lang.String pickListId)
          Gets the pick list definition by 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 all the pickListIds that contain supplied supported tag and value.
 java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionURI(java.lang.String valueSetDefURI)
          Gets the list of pick list definitions that are derived by supplied value set definition URI.
 java.lang.String getPickListEntryNodeGuidByPickListIdAndPLEntryId(java.lang.String pickListId, java.lang.String plEntryId)
          Returns the plEntryGUID for pickListId and pickListEntryId.
 java.lang.String getPickListEntryStateUId(java.lang.String pickListDefUId)
           
 java.lang.String getPickListGuidFromPickListId(java.lang.String pickListId)
          Gets the guid from pick list id.
 java.util.List<java.lang.String> getPickListIds()
          Gets the pick list ids.
 java.lang.String insertHistoryPickListDefinition(java.lang.String pickListDefUId, java.lang.String pickListId)
           
 java.lang.String insertPickListDefinition(PickListDefinition definition, java.lang.String systemReleaseUri, Mappings mappings)
          Insert pick list definition.
 void removePickListDefinitionByPickListId(java.lang.String pickListDefinitionId)
          Delete pick list definition by pick list id.
 PickListDefinition resolvePickListByRevision(java.lang.String pickListId, java.lang.String revisionId, java.lang.Integer sortType)
           
 void updateEntryStateUId(java.lang.String pickListDefUId, java.lang.String entryStateUId)
           
 java.lang.String updatePickListDefinition(java.lang.String pickListDefUId, PickListDefinition definition)
           
 java.lang.String updateVersionableAttributes(java.lang.String pickListDefUId, PickListDefinition definition)
           
 
Methods inherited from interface org.lexevs.dao.database.access.LexGridSchemaVersionAwareDao
executeInTransaction, supportsLgSchemaVersion
 

Method Detail

getPickListDefinitionById

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

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

getPickListDefinitionIdForValueSetDefinitionURI

java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionURI(java.lang.String valueSetDefURI)
Gets the list of pick list definitions that are derived by supplied value set definition URI.

Parameters:
valueSet - the uri of value set definition
Returns:
the pick list id

getPickListGuidFromPickListId

java.lang.String getPickListGuidFromPickListId(java.lang.String pickListId)
Gets the guid from pick list id.

Parameters:
pickListId - the pick list id
Returns:
the guid from pick list id

getPickListEntryNodeGuidByPickListIdAndPLEntryId

java.lang.String getPickListEntryNodeGuidByPickListIdAndPLEntryId(java.lang.String pickListId,
                                                                  java.lang.String plEntryId)
Returns the plEntryGUID for pickListId and pickListEntryId.

Parameters:
pickListId -
plEntryId -
Returns:
the plEntryGuid

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 all the pickListIds that contain supplied supported tag and value.

Parameters:
supportedTag - like SupportedCodingScheme, SupportedAssociation etc.
value - value to look for
Returns:
list of pickListIds that contains supportedTag with value.

insertPickListDefinition

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

Parameters:
systemReleaseUri - the system release uri
definition - the definition
Returns:
the string

getPickListIds

java.util.List<java.lang.String> getPickListIds()
Gets the pick list ids.

Returns:
the pick list ids

removePickListDefinitionByPickListId

void removePickListDefinitionByPickListId(java.lang.String pickListDefinitionId)
Delete pick list definition by pick list id.

Parameters:
pickListDefinitionId - the pick list definition id

insertHistoryPickListDefinition

java.lang.String insertHistoryPickListDefinition(java.lang.String pickListDefUId,
                                                 java.lang.String pickListId)

updatePickListDefinition

java.lang.String updatePickListDefinition(java.lang.String pickListDefUId,
                                          PickListDefinition definition)

updateVersionableAttributes

java.lang.String updateVersionableAttributes(java.lang.String pickListDefUId,
                                             PickListDefinition definition)

getPickListEntryStateUId

java.lang.String getPickListEntryStateUId(java.lang.String pickListDefUId)

updateEntryStateUId

void updateEntryStateUId(java.lang.String pickListDefUId,
                         java.lang.String entryStateUId)

getLatestRevision

java.lang.String getLatestRevision(java.lang.String pickListDefUId)

entryStateExists

boolean entryStateExists(java.lang.String entryStateUId)

resolvePickListByRevision

PickListDefinition resolvePickListByRevision(java.lang.String pickListId,
                                             java.lang.String revisionId,
                                             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.