org.openmrs.api.db
Interface ConceptDAO

All Known Implementing Classes:
HibernateConceptDAO

public interface ConceptDAO

Concept-related database functions

See Also:
ConceptService

Method Summary
 java.util.List<ConceptClass> getAllConceptClasses(boolean includeRetired)
           
 java.util.List<ConceptDatatype> getAllConceptDatatypes(boolean includeRetired)
           
 java.util.List<ConceptProposal> getAllConceptProposals(boolean includeComplete)
           
 java.util.List<Concept> getAllConcepts(java.lang.String sortBy, boolean asc, boolean includeRetired)
           
 Concept getConcept(java.lang.Integer conceptId)
           
 ConceptAnswer getConceptAnswer(java.lang.Integer conceptAnswerId)
           
 ConceptClass getConceptClass(java.lang.Integer i)
           
 java.util.List<ConceptClass> getConceptClasses(java.lang.String name)
           
 ConceptDatatype getConceptDatatype(java.lang.Integer i)
           
 java.util.List<ConceptDatatype> getConceptDatatypes(java.lang.String name)
           
 ConceptNumeric getConceptNumeric(java.lang.Integer conceptId)
           
 ConceptProposal getConceptProposal(java.lang.Integer i)
           
 java.util.List<ConceptProposal> getConceptProposals(java.lang.String text)
           
 java.util.List<Concept> getConcepts(java.lang.String name, java.util.Locale loc, boolean searchOnPhrase, java.util.List<ConceptClass> classes, java.util.List<ConceptDatatype> datatypes)
          Returns a list of concepts based on the search criteria
 java.util.List<Concept> getConceptsByAnswer(Concept concept)
           
 java.util.List<ConceptSet> getConceptSetsByConcept(Concept c)
           
 java.util.List<Concept> getConceptsWithDrugsInFormulary()
           
 java.util.List<ConceptWord> getConceptWords(java.lang.String phrase, java.util.List<java.util.Locale> locales, boolean includeRetired, java.util.List<ConceptClass> requireClasses, java.util.List<ConceptClass> excludeClasses, java.util.List<ConceptDatatype> requireDatatypes, java.util.List<ConceptDatatype> excludeDatatypes, Concept answersToConcept, java.lang.Integer start, java.lang.Integer size)
           
 Drug getDrug(java.lang.Integer drugId)
           
 java.util.List<Drug> getDrugs(java.lang.String phrase)
           
 java.util.List<Drug> getDrugs(java.lang.String drugName, Concept concept, boolean includeRetired)
          DAO for retrieving a list of drugs based on the following criteria
 java.lang.Integer getNextAvailableId()
           
 Concept getNextConcept(Concept c)
           
 Concept getPrevConcept(Concept c)
           
 java.util.List<Concept> getProposedConcepts(java.lang.String text)
           
 java.util.List<ConceptSet> getSetsContainingConcept(Concept concept)
           
 void purgeConcept(Concept concept)
           
 void purgeConceptClass(ConceptClass cc)
           
 void purgeConceptDatatype(ConceptDatatype cd)
           
 void purgeConceptProposal(ConceptProposal cp)
           
 void purgeDrug(Drug drug)
           
 Concept saveConcept(Concept concept)
           
 ConceptClass saveConceptClass(ConceptClass cc)
           
 ConceptDatatype saveConceptDatatype(ConceptDatatype cd)
           
 ConceptProposal saveConceptProposal(ConceptProposal cp)
           
 Drug saveDrug(Drug drug)
           
 void updateConceptSetDerived()
           
 void updateConceptSetDerived(Concept concept)
           
 void updateConceptWord(Concept concept)
           
 

Method Detail

saveConcept

Concept saveConcept(Concept concept)
                    throws DAOException
Throws:
DAOException
See Also:
ConceptService.saveConcept(org.openmrs.Concept)

purgeConcept

void purgeConcept(Concept concept)
                  throws DAOException
Throws:
DAOException
See Also:
ConceptService.purgeConcept(org.openmrs.Concept)

purgeDrug

void purgeDrug(Drug drug)
               throws DAOException
Throws:
DAOException
See Also:
ConceptService.purgeDrug(org.openmrs.Drug)

saveDrug

Drug saveDrug(Drug drug)
              throws DAOException
Throws:
DAOException
See Also:
ConceptService.saveDrug(org.openmrs.Drug)

getConcept

Concept getConcept(java.lang.Integer conceptId)
                   throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConcept(java.lang.Integer)

getAllConcepts

java.util.List<Concept> getAllConcepts(java.lang.String sortBy,
                                       boolean asc,
                                       boolean includeRetired)
                                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.getAllConcepts(java.lang.String, boolean, boolean)

getConcepts

java.util.List<Concept> getConcepts(java.lang.String name,
                                    java.util.Locale loc,
                                    boolean searchOnPhrase,
                                    java.util.List<ConceptClass> classes,
                                    java.util.List<ConceptDatatype> datatypes)
                                    throws DAOException
Returns a list of concepts based on the search criteria

Parameters:
name -
loc -
searchOnPhrase - This puts wildcard characters around the concept name search criteria
Returns:
List
Throws:
DAOException

getConceptWords

java.util.List<ConceptWord> getConceptWords(java.lang.String phrase,
                                            java.util.List<java.util.Locale> locales,
                                            boolean includeRetired,
                                            java.util.List<ConceptClass> requireClasses,
                                            java.util.List<ConceptClass> excludeClasses,
                                            java.util.List<ConceptDatatype> requireDatatypes,
                                            java.util.List<ConceptDatatype> excludeDatatypes,
                                            Concept answersToConcept,
                                            java.lang.Integer start,
                                            java.lang.Integer size)
                                            throws DAOException
Throws:
DAOException
See Also:
org.openmrs.api.ConceptService#getConceptWords(java.lang.String, java.util.Locale, boolean, java.util.List, java.util.List, java.util.List, java.util.List, Concept, int, int)

getConceptAnswer

ConceptAnswer getConceptAnswer(java.lang.Integer conceptAnswerId)
                               throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptAnswer(java.lang.Integer)

getDrug

Drug getDrug(java.lang.Integer drugId)
             throws DAOException
Throws:
DAOException
See Also:
ConceptService.getDrug(java.lang.Integer)

getDrugs

java.util.List<Drug> getDrugs(java.lang.String drugName,
                              Concept concept,
                              boolean includeRetired)
                              throws DAOException
DAO for retrieving a list of drugs based on the following criteria

Parameters:
drugName -
concept -
includeRetired -
Returns:
List
Throws:
DAOException

getDrugs

java.util.List<Drug> getDrugs(java.lang.String phrase)
                              throws DAOException
Throws:
DAOException
See Also:
ConceptService.getDrugs(java.lang.String)

getConceptClass

ConceptClass getConceptClass(java.lang.Integer i)
                             throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptClass(java.lang.Integer)

getConceptClasses

java.util.List<ConceptClass> getConceptClasses(java.lang.String name)
                                               throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptClassByName(java.lang.String)

getAllConceptClasses

java.util.List<ConceptClass> getAllConceptClasses(boolean includeRetired)
                                                  throws DAOException
Throws:
DAOException
See Also:
ConceptService.getAllConceptClasses(boolean)

saveConceptClass

ConceptClass saveConceptClass(ConceptClass cc)
                              throws DAOException
Throws:
DAOException
See Also:
ConceptService.saveConceptClass(org.openmrs.ConceptClass)

purgeConceptClass

void purgeConceptClass(ConceptClass cc)
                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.purgeConceptClass(org.openmrs.ConceptClass)

getAllConceptDatatypes

java.util.List<ConceptDatatype> getAllConceptDatatypes(boolean includeRetired)
                                                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.getAllConceptDatatypes(boolean)

getConceptDatatypes

java.util.List<ConceptDatatype> getConceptDatatypes(java.lang.String name)
                                                    throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptDatatypes(java.lang.String)

getConceptDatatype

ConceptDatatype getConceptDatatype(java.lang.Integer i)
                                   throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptDatatype(java.lang.Integer)

saveConceptDatatype

ConceptDatatype saveConceptDatatype(ConceptDatatype cd)
                                    throws DAOException
Throws:
DAOException
See Also:
ConceptService.saveConceptDatatype(org.openmrs.ConceptDatatype)

purgeConceptDatatype

void purgeConceptDatatype(ConceptDatatype cd)
                          throws DAOException
Throws:
DAOException
See Also:
ConceptService.purgeConceptDatatype(org.openmrs.ConceptDatatype)

updateConceptSetDerived

void updateConceptSetDerived(Concept concept)
                             throws DAOException
Throws:
DAOException
See Also:
ConceptService.updateConceptSetDerived(org.openmrs.Concept)

updateConceptSetDerived

void updateConceptSetDerived()
                             throws DAOException
Throws:
DAOException
See Also:
ConceptService.updateConceptSetDerived()

getConceptSetsByConcept

java.util.List<ConceptSet> getConceptSetsByConcept(Concept c)
                                                   throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptSetsByConcept(org.openmrs.Concept)

getSetsContainingConcept

java.util.List<ConceptSet> getSetsContainingConcept(Concept concept)
                                                    throws DAOException
Throws:
DAOException
See Also:
ConceptService.getSetsContainingConcept(org.openmrs.Concept)

getConceptNumeric

ConceptNumeric getConceptNumeric(java.lang.Integer conceptId)
                                 throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptNumeric(java.lang.Integer)

getConceptsByAnswer

java.util.List<Concept> getConceptsByAnswer(Concept concept)
                                            throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptsByAnswer(org.openmrs.Concept)

getPrevConcept

Concept getPrevConcept(Concept c)
                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.getPrevConcept(org.openmrs.Concept)

getNextConcept

Concept getNextConcept(Concept c)
                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.getNextConcept(org.openmrs.Concept)

getAllConceptProposals

java.util.List<ConceptProposal> getAllConceptProposals(boolean includeComplete)
                                                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.getAllConceptProposals(boolean)

getConceptProposal

ConceptProposal getConceptProposal(java.lang.Integer i)
                                   throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptProposal(java.lang.Integer)

getConceptProposals

java.util.List<ConceptProposal> getConceptProposals(java.lang.String text)
                                                    throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptProposals(java.lang.String)

getProposedConcepts

java.util.List<Concept> getProposedConcepts(java.lang.String text)
                                            throws DAOException
Throws:
DAOException
See Also:
ConceptService.getProposedConcepts(java.lang.String)

saveConceptProposal

ConceptProposal saveConceptProposal(ConceptProposal cp)
                                    throws DAOException
Throws:
DAOException
See Also:
ConceptService.saveConceptProposal(org.openmrs.ConceptProposal)

purgeConceptProposal

void purgeConceptProposal(ConceptProposal cp)
                          throws DAOException
Throws:
DAOException
See Also:
ConceptService.purgeConceptProposal(org.openmrs.ConceptProposal)

getNextAvailableId

java.lang.Integer getNextAvailableId()
                                     throws DAOException
Throws:
DAOException
See Also:
ConceptService.getNextAvailableId()

getConceptsWithDrugsInFormulary

java.util.List<Concept> getConceptsWithDrugsInFormulary()
                                                        throws DAOException
Throws:
DAOException
See Also:
ConceptService.getConceptsWithDrugsInFormulary()

updateConceptWord

void updateConceptWord(Concept concept)
                       throws DAOException
Throws:
DAOException
See Also:
ConceptService.updateConceptWord(org.openmrs.Concept)

OpenMRS-trunk

Generated May 29 2008 02:01 AM. NOTE - these libraries are in active development and subject to change