Package org.openmrs.api.db

OpenMRS database layer interfaces.

See: Description

Interface Summary

Interface	Description
AdministrationDAO	Database methods for the AdministrationService
CohortDAO	Database methods for cohort objects.
ConceptDAO	Concept-related database functions
ConditionDAO	This interface defines database methods for condition objects.
ContextDAO	Defines the functions that the Context needs to access the database
DatatypeDAO	Data access for custom datatypes
DiagnosisDAO	This interface defines database methods for diagnosis objects.
EncounterDAO	Encounter-related database functions
FormDAO	Database access functions for the Form, FormField, and Field objects
FullTextSessionFactory	Interface to be implemented by objects that are factories of FullTextSession instances.
LocationDAO	Location-related database functions
MedicationDispenseDAO	This interface defines database methods for the MedicationDispense domain
ObsDAO	Observation-related database functions
OpenmrsDataDAO<T extends BaseOpenmrsData>	In OpenMRS, we distinguish between data and metadata within our data model.
OpenmrsMetadataDAO<T extends BaseOpenmrsMetadata>	In OpenMRS, we distinguish between data and metadata within our data model.
OpenmrsObjectDAO<T extends BaseOpenmrsObject>	Generic interface for all OpenMrs DAOs
OrderDAO	Order-related database functions This class should never be used directly.
OrderSetDAO	OrderSet-related database functions This class should never be used directly.
PatientDAO	Database methods for the PatientService
PersonDAO	Person-related database functions This is used by the PersonService.
ProgramWorkflowDAO	Program- and PatientProgram- and ConceptStateConversion-related database functions
ProviderDAO	Data Access function for Provider
SerializedObjectDAO	The SerializedObjectDAO is meant to be used as a means for persisting objects for which a typical relational table model is impractical.
TemplateDAO	Message template related database functions
UserDAO	Database methods for the UserService
VisitDAO	Database access functions for visits.

Class Summary

Class	Description
ClobDatatypeStorage	Stores a potentially-long String value, for clob-based custom datatypes
DelegatingFullTextSession	Custom implementation of the FullTextSession interface that acts a wrapper around a target FullTextSession instance, it actually delegates all the method calls directly to the target except for the FullTextSession.createFullTextQuery(Query, Class[]) method where it first notifies registered listeners of the creation event before returning the newly created FullTextQuery object.
FullTextQueryAndEntityClass	Wrapper class around a FullTextQuery object and the Type of the entities to be returned by the query.
FullTextQueryCreatedEvent	Represents an event object raised whenever a FullTextQuery object is created.
FullTextSessionFactoryImpl
LoginCredential	This class holds the minimal amount of data necessary to change a user's password without using a PreparedStatement or putting the password in the User class.
SerializedObject	Object representation of a Serialized Object as stored in the database.

Exception Summary

Exception	Description
DAOException	Represents often fatal errors that occur within the database layer.

Package org.openmrs.api.db Description

OpenMRS database layer interfaces. These data access objects (DAOs) provide the necessary methods to access and manipulate OpenMRS domain objects.

DAOs should be used by the API (org.openmrs.api.*Services) and rarely (if ever) accessed directly.