Uses of Interface
org.openmrs.OpenmrsObject

Packages that use OpenmrsObject

Package	Description
org.openmrs	These classes represent the core domain objects for the OpenMRS project.
org.openmrs.aop	This package contains the classes associated with Aspect Oriented Programming (AOP).
org.openmrs.api	The primary OpenMRS API interfaces.
org.openmrs.api.context	This package describes the context framework through which authentication is performed and services provided for the OpenMRS system.
org.openmrs.api.db	OpenMRS database layer interfaces.
org.openmrs.api.db.hibernate	Resources for Hibernate ORM.
org.openmrs.api.handler
org.openmrs.api.impl
org.openmrs.attribute
org.openmrs.customdatatype.datatype
org.openmrs.hl7	OpenMRS HL7 module.
org.openmrs.notification
org.openmrs.person
org.openmrs.propertyeditor
org.openmrs.scheduler

Uses of OpenmrsObject in org.openmrs

Subinterfaces of OpenmrsObject in org.openmrs

Modifier and Type	Interface and Description
interface	Auditable In OpenMRS, the convention is to track basic audit information for each object related to who initially created the object and when, and who last changed the object and when.
interface	Changeable Base interface for domain objects that need to track information related to when they were changed and the user that last changed them.
interface	Creatable Base interface for domain objects that need to track information related to when they were created and the user that created them.
interface	OpenmrsData In OpenMRS, we distinguish between data and metadata within our data model.
interface	OpenmrsMetadata In OpenMRS, we distinguish between data and metadata within our data model.
interface	Retireable In OpenMRS, data are rarely fully deleted (purged) from the system; rather, they are either voided or retired.
interface	Voidable In OpenMRS, data are rarely fully deleted (purged) from the system; rather, they are either voided or retired.

Classes in org.openmrs that implement OpenmrsObject

Modifier and Type	Class and Description
class	Allergy Represent allergy
class	AllergyReaction Represent allergy reactions
class	BaseChangeableOpenmrsData Base superclass for all mutable OpenmrsData.
class	BaseChangeableOpenmrsMetadata Base superclass for all mutable OpenmrsMetadata.
class	BaseConceptMap Superclass for ConceptMaps and ConceptReferenceTermMaps
class	BaseCustomizableData<A extends Attribute> Extension of BaseOpenmrsData for classes that support customization via user-defined attributes.
class	BaseCustomizableMetadata<A extends Attribute> Extension of BaseOpenmrsMetadata for classes that support customization via user-defined attributes.
class	BaseFormRecordableOpenmrsData Base implementation of FormRecordable that bridges between a saved BaseChangeableOpenmrsData entity and the path in a form where it was recorded.
class	BaseOpenmrsData In OpenMRS, we distinguish between data and metadata within our data model.
class	BaseOpenmrsMetadata In OpenMRS, we distinguish between data and metadata within our data model.
class	BaseOpenmrsObject This is the base implementation of the OpenmrsObject interface.
class	CareSetting Care Setting defines the scope of care for any piece of data within the medical record.
class	Cohort This class represents a list of patientIds.
class	CohortMembership
class	Concept A Concept object can represent either a question or an answer to a data point.
class	ConceptAnswer This class represents one option for an answer to a question type of Concept.
class	ConceptAttribute
class	ConceptAttributeType
class	ConceptClass ConceptClass
class	ConceptComplex Child class of Concept that has a ComplexObsHandler associated with the Concept.
class	ConceptDatatype ConceptDatatype
class	ConceptDescription ConceptDescription is the localized description of a concept.
class	ConceptMap The concept map object represents a mapping of Concept to ConceptSource.
class	ConceptMapType ConceptMapType are used to define relationships between concepts and concept reference terms e.g IS_A or SAME_AS, BROADER_THAN
class	ConceptName ConceptName is the real world term used to express a Concept within the idiom of a particular locale.
class	ConceptNameTag ConceptNameTag is a textual tag which can be applied to a ConceptName.
class	ConceptNumeric The ConceptNumeric extends upon the Concept object by adding some number range values
class	ConceptProposal A ConceptProposal is a temporary holder for concept that should be in the system.
class	ConceptReferenceTerm A concept reference term is typically name for a concept by which it is referred in another institution like ICD9, ICD10, SNOMED that keeps a concept dictionary or any other OpenMRS implementation
class	ConceptReferenceTermMap The concept Reference Term map object represents a mapping between two Concept Reference Terms.
class	ConceptSet This represents a single concept within a concept set.
class	ConceptSource A concept source is defined as any institution that keeps a concept dictionary.
class	ConceptStateConversion ConceptStateConversion
class	ConceptStopWord ConceptStopWord is the real world term used to filter the words for indexing from search phrase.
class	Condition The condition class records detailed information about a condition, problem, diagnosis, or other situation or issue.
class	Diagnosis Diagnosis class defines the identification of the nature of an illness or other problem by examination of the symptoms during an encounter (visit or interaction of a patient with a healthcare worker).
class	DiagnosisAttribute The DiagnosisAttribute, value for the DiagnosisAttributeType that is stored in a Diagnosis.
class	DiagnosisAttributeType The DiagnosisAttributeType extension to the Diagnosis class.
class	Drug Drug
class	DrugIngredient DrugIngredient
class	DrugOrder DrugOrder
class	DrugReferenceMap The DrugReferenceMap map object represents a mapping between a drug and alternative drug terminologies.
class	Encounter An Encounter represents one visit or interaction of a patient with a healthcare worker.
class	EncounterProvider Mapping Class between Encounters and Providers which allows many to many relationship.
class	EncounterRole An EncounterRole a role specific to the encounter.
class	EncounterType An EncounterType defines how a certain kind of Encounter.
class	Field Field
class	FieldAnswer FieldAnswer
class	FieldType FieldType
class	Form Form
class	FormField The FormField object relates/orders the fields on a form A form can have many 0 to n fields associated with it in a hierarchical manor.
class	FormResource A FormResource is meant as a way for modules to add arbitrary information to a Form.
class	GlobalProperty Global properties are simple key-value pairs persisted in the database GPs can be thought of as something similar to environment variables used in operating systems.
class	Location A Location is a physical place, such as a hospital, a room, a clinic, or a district.
class	LocationAttribute A value for a user-defined LocationAttributeType that is stored on a Location.
class	LocationAttributeType A user-defined extension to the Location class.
class	LocationTag An LocationTag allows categorization of Locations
class	MedicationDispense The MedicationDispense class records detailed information about the provision of a supply of a medication with the intention that it is subsequently consumed by a patient (usually in response to a prescription).
class	Obs An observation is a single unit of clinical information.
class	Order Encapsulates information about the clinical action of a provider requesting something for a patient e.g requesting a test to be performed, prescribing a medication, requesting the patient to enroll on a specific diet etc.
class	OrderAttribute The OrderAttribute, value for the OrderAttributeType that is stored in an Order.
class	OrderAttributeType The OrderAttributeType, extension to the Order class.
class	OrderFrequency The frequency at which an Order's action should be repeated, e.g.
class	OrderGroup Contains a group of Orders that are ordered together within a single encounter,often driven by an OrderSet.
class	OrderGroupAttribute A value for a user-defined OrderGroupAttributeType that is stored in an OrderGroup.
class	OrderGroupAttributeType A user-defined extension to the OrderGroup class.
class	OrderSet Represents the grouping of orders into a set, so as to give decision support for the doctors
class	OrderSetAttribute A value for a user-defined OrderSetAttributeType that is stored on a OrderSet.
class	OrderSetAttributeType A user-defined extension to the OrderSet class.
class	OrderSetMember
class	OrderType OrderTypes are used to classify different types of Orders e.g to distinguish between Serology and Radiology TestOrders
class	Patient Defines a Patient in the system.
class	PatientIdentifier A Patient can have zero to n identifying PatientIdentifier(s).
class	PatientIdentifierType PatientIdentifierType
class	PatientProgram PatientProgram
class	PatientProgramAttribute
class	PatientState PatientState
class	Person A Person in the system.
class	PersonAddress This class is the representation of a person's address.
class	PersonAttribute A PersonAttribute is meant as way for implementations to add arbitrary information about a user/patient to their database.
class	PersonAttributeType PersonAttributeType
class	PersonName A Person can have zero to n PersonName(s).
class	Privilege Privilege
class	Program Program
class	ProgramAttributeType
class	ProgramWorkflow ProgramWorkflow
class	ProgramWorkflowState ProgramWorkflowState
class	Provider Represents a person who may provide care to a patient during an encounter
class	ProviderAttribute A value for a user-defined ProviderAttributeType that is stored on a Provider.
class	ProviderAttributeType A user-defined extension to the Provider class.
class	ReferralOrder This is a type of order that adds referral specific attributes.
class	Relationship Relationship
class	RelationshipType Defines a type of relationship between two people in the database.
class	Role A Role is just an aggregater of Privileges.
class	ServiceOrder Provides properties for several order types like TestOrder , ReferralOrder and others depending on the openmrs implementation use case as need arises
class	TestOrder This is a type of order that adds tests specific attributes like: laterality, clinical history, etc.
class	User Defines a User Account in the system.
class	Visit A 'visit' is a contiguous time period where encounters occur between patients and healthcare providers.
class	VisitAttribute A value for a user-defined VisitAttributeType that is stored on a Visit.
class	VisitAttributeType A user-defined extension to the Visit class.
class	VisitType Represents the assortment of visit types available to an implementation.

Uses of OpenmrsObject in org.openmrs.aop

Methods in org.openmrs.aop with type parameters of type OpenmrsObject

Modifier and Type	Method and Description
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, String reason) Convenience method for RequiredDataAdvice.recursivelyHandle(Class, OpenmrsObject, User, Date, String, List).
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, User currentUser, Date currentDate, String other, List<OpenmrsObject> alreadyHandled) This loops over all declared collections on the given object and all declared collections on parent objects to use the given handlerType.
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, User currentUser, Date currentDate, String other, Set<OpenmrsObject> alreadyHandled) This loops over all declared collections on the given object and all declared collections on parent objects to use the given handlerType.

Methods in org.openmrs.aop that return types with arguments of type OpenmrsObject

Modifier and Type	Method and Description
protected static Collection<OpenmrsObject>	RequiredDataAdvice.getChildCollection(OpenmrsObject openmrsObject, Field field) This method gets a child attribute off of an OpenmrsObject.

Methods in org.openmrs.aop with parameters of type OpenmrsObject

Modifier and Type	Method and Description
protected static Collection<OpenmrsObject>	RequiredDataAdvice.getChildCollection(OpenmrsObject openmrsObject, Field field) This method gets a child attribute off of an OpenmrsObject.
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, String reason) Convenience method for RequiredDataAdvice.recursivelyHandle(Class, OpenmrsObject, User, Date, String, List).
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, User currentUser, Date currentDate, String other, List<OpenmrsObject> alreadyHandled) This loops over all declared collections on the given object and all declared collections on parent objects to use the given handlerType.
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, User currentUser, Date currentDate, String other, Set<OpenmrsObject> alreadyHandled) This loops over all declared collections on the given object and all declared collections on parent objects to use the given handlerType.

Method parameters in org.openmrs.aop with type arguments of type OpenmrsObject

Modifier and Type	Method and Description
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, User currentUser, Date currentDate, String other, List<OpenmrsObject> alreadyHandled) This loops over all declared collections on the given object and all declared collections on parent objects to use the given handlerType.
static <H extends RequiredDataHandler<OpenmrsObject>> void	RequiredDataAdvice.recursivelyHandle(Class<H> handlerType, OpenmrsObject openmrsObject, User currentUser, Date currentDate, String other, Set<OpenmrsObject> alreadyHandled) This loops over all declared collections on the given object and all declared collections on parent objects to use the given handlerType.

Uses of OpenmrsObject in org.openmrs.api

Method parameters in org.openmrs.api with type arguments of type OpenmrsObject

Modifier and Type	Method and Description
int	AdministrationService.getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass, String fieldName)

Uses of OpenmrsObject in org.openmrs.api.context

Methods in org.openmrs.api.context with parameters of type OpenmrsObject

Modifier and Type	Method and Description
static void	Context.evictEntity(OpenmrsObject object) Evicts the entity data for a particular entity instance.

Uses of OpenmrsObject in org.openmrs.api.db

Classes in org.openmrs.api.db that implement OpenmrsObject

Modifier and Type	Class and Description
class	ClobDatatypeStorage Stores a potentially-long String value, for clob-based custom datatypes
class	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.
class	SerializedObject Object representation of a Serialized Object as stored in the database.

Methods in org.openmrs.api.db with type parameters of type OpenmrsObject

Modifier and Type	Method and Description
<T extends OpenmrsObject> T	SerializedObjectDAO.convertSerializedObject(Class<T> clazz, SerializedObject serializedObject) Converts a raw SerializedObject to an OpenmrsObject, using the appropriate Serializer
<T extends OpenmrsObject> List<T>	SerializedObjectDAO.getAllObjects(Class<T> type) Retrieves all non-retired objects of the passed type from the database that have been saved through serialization
<T extends OpenmrsObject> List<T>	SerializedObjectDAO.getAllObjects(Class<T> type, boolean includeRetired) Retrieves all objects from the database that match the passed type that have been saved through serialization Returns voided / retired Objects only if includeRetired parameter is true
<T extends OpenmrsObject> T	SerializedObjectDAO.getObject(Class<T> type, Integer id) Retrieves the saved object of the passed type from the database by it's id
<T extends OpenmrsObject> T	SerializedObjectDAO.getObjectByUuid(Class<T> type, String uuid) Retrieves the saved object of the passed type from the database by it's uuid
<T extends OpenmrsObject> T	SerializedObjectDAO.saveObject(T object) Saves an object to the database in serialized form
<T extends OpenmrsObject> T	SerializedObjectDAO.saveObject(T object, OpenmrsSerializer serializer) Saves an object to the database, in serialized form, using the specified OpenmrsSerializer

Methods in org.openmrs.api.db that return types with arguments of type OpenmrsObject

Modifier and Type	Method and Description
Class<? extends OpenmrsObject>	SerializedObjectDAO.getRegisteredTypeForObject(OpenmrsObject object) Returns the registered class for the passed object, or null if none found For example, if the supportedTypes property contains the CohortDefinition.class interface, and a particular implementation of that interface is passed in, then this method would return CohortDefinition.class.
List<Class<? extends OpenmrsObject>>	SerializedObjectDAO.getSupportedTypes()

Methods in org.openmrs.api.db with parameters of type OpenmrsObject

Modifier and Type	Method and Description
void	ContextDAO.evictEntity(OpenmrsObject object) Evicts the entity data for a particular entity instance.
Class<? extends OpenmrsObject>	SerializedObjectDAO.getRegisteredTypeForObject(OpenmrsObject object) Returns the registered class for the passed object, or null if none found For example, if the supportedTypes property contains the CohortDefinition.class interface, and a particular implementation of that interface is passed in, then this method would return CohortDefinition.class.

Method parameters in org.openmrs.api.db with type arguments of type OpenmrsObject

Modifier and Type	Method and Description
int	AdministrationDAO.getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass, String fieldName)
void	SerializedObjectDAO.registerSupportedType(Class<? extends OpenmrsObject> clazz) Registers a class as one that should be supported
void	SerializedObjectDAO.unregisterSupportedType(Class<? extends OpenmrsObject> clazz) Removes this class as one that should be supported

Uses of OpenmrsObject in org.openmrs.api.db.hibernate

Methods in org.openmrs.api.db.hibernate with type parameters of type OpenmrsObject

Modifier and Type	Method and Description
<T extends OpenmrsObject> T	HibernateSerializedObjectDAO.convertSerializedObject(Class<T> clazz, SerializedObject serializedObject)
<T extends OpenmrsObject> List<T>	HibernateSerializedObjectDAO.getAllObjects(Class<T> type)
<T extends OpenmrsObject> List<T>	HibernateSerializedObjectDAO.getAllObjects(Class<T> type, boolean includeRetired)
<T extends OpenmrsObject> T	HibernateSerializedObjectDAO.getObject(Class<T> baseClass, Integer id)
<T extends OpenmrsObject> T	HibernateSerializedObjectDAO.getObjectByUuid(Class<T> baseClass, String uuid)
<T extends OpenmrsObject> T	HibernateSerializedObjectDAO.saveObject(T object)
<T extends OpenmrsObject> T	HibernateSerializedObjectDAO.saveObject(T object, OpenmrsSerializer serializer)

Methods in org.openmrs.api.db.hibernate that return types with arguments of type OpenmrsObject

Modifier and Type	Method and Description
Class<? extends OpenmrsObject>	HibernateSerializedObjectDAO.getRegisteredTypeForObject(OpenmrsObject object)
List<Class<? extends OpenmrsObject>>	HibernateSerializedObjectDAO.getSupportedTypes()

Methods in org.openmrs.api.db.hibernate with parameters of type OpenmrsObject

Modifier and Type	Method and Description
void	HibernateContextDAO.evictEntity(OpenmrsObject obj)
Class<? extends OpenmrsObject>	HibernateSerializedObjectDAO.getRegisteredTypeForObject(OpenmrsObject object)

Method parameters in org.openmrs.api.db.hibernate with type arguments of type OpenmrsObject

Modifier and Type	Method and Description
int	HibernateAdministrationDAO.getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass, String fieldName)
void	HibernateSerializedObjectDAO.registerSupportedType(Class<? extends OpenmrsObject> clazz)
void	HibernateSerializedObjectDAO.setSupportedTypes(List<Class<? extends OpenmrsObject>> supportedTypes)
void	HibernateSerializedObjectDAO.unregisterSupportedType(Class<? extends OpenmrsObject> clazz)

Uses of OpenmrsObject in org.openmrs.api.handler

Classes in org.openmrs.api.handler with type parameters of type OpenmrsObject

Modifier and Type	Interface and Description
interface	RequiredDataHandler<O extends OpenmrsObject> This is the super interface for all save*, void*, and retire* actions that take place on all services.
interface	SaveHandler<O extends OpenmrsObject> This is the super interface for all save* actions that take place on all services.

Methods in org.openmrs.api.handler with parameters of type OpenmrsObject

Modifier and Type	Method and Description
void	OpenmrsObjectSaveHandler.handle(OpenmrsObject openmrsObject, User creator, Date dateCreated, String reason) This sets the uuid property on the given OpenmrsObject if it is non-null.

Uses of OpenmrsObject in org.openmrs.api.impl

Method parameters in org.openmrs.api.impl with type arguments of type OpenmrsObject

Modifier and Type	Method and Description
int	AdministrationServiceImpl.getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass, String fieldName)

Uses of OpenmrsObject in org.openmrs.attribute

Subinterfaces of OpenmrsObject in org.openmrs.attribute

Modifier and Type	Interface and Description
interface	Attribute<AT extends AttributeType,OT extends Customizable<?>> Common interface for user-defined attribute that is are added to a base class.
interface	AttributeType<OwningType extends Customizable<?>> Common interface for user-defined extensions to core domain objects, which would be handled by adding custom database columns in a less generic system.

Classes in org.openmrs.attribute that implement OpenmrsObject

Modifier and Type	Class and Description
class	BaseAttribute<AT extends AttributeType,OwningType extends Customizable<?>> Abstract base implementation of Attribute.
class	BaseAttributeType<OwningType extends Customizable<?>> Abstract base implementation of AttributeType.

Uses of OpenmrsObject in org.openmrs.customdatatype.datatype

Classes in org.openmrs.customdatatype.datatype with type parameters of type OpenmrsObject

Modifier and Type	Class and Description
class	BaseOpenmrsDatatype<T extends OpenmrsObject> This is a superclass for custom datatypes for OpenmrsObjects

Uses of OpenmrsObject in org.openmrs.hl7

Classes in org.openmrs.hl7 that implement OpenmrsObject

Modifier and Type	Class and Description
class	HL7InArchive Represents a successfully processed hl7 message.
class	HL7InError Represents a error in processing an hl7 message.
class	HL7InQueue Represents an hl7 message that has yet to be processed.
class	HL7QueueItem Common representation of HL7InQueue, HL7InArchive and HL7InError.
class	HL7Source Names a unique location that hl7 messages could be coming from.

Uses of OpenmrsObject in org.openmrs.notification

Classes in org.openmrs.notification that implement OpenmrsObject

Modifier and Type	Class and Description
class	Alert Alerts are the simplest form of communication.
class	AlertRecipient This class is essentially a wrapper for the user object.
class	Template

Uses of OpenmrsObject in org.openmrs.person

Classes in org.openmrs.person that implement OpenmrsObject

Modifier and Type	Class and Description
class	PersonMergeLog This class represents the audit of a merge of two persons.

Uses of OpenmrsObject in org.openmrs.propertyeditor

Classes in org.openmrs.propertyeditor with type parameters of type OpenmrsObject

Modifier and Type	Class and Description
class	OpenmrsPropertyEditor<T extends OpenmrsObject> Base PropertyEditor for OpenmrsObject.

Uses of OpenmrsObject in org.openmrs.scheduler

Classes in org.openmrs.scheduler that implement OpenmrsObject

Modifier and Type	Class and Description
class	TaskDefinition Represents the metadata for a task that can be scheduled.