org.openmrs

Interface OpenmrsMetadata

All Superinterfaces:

Auditable, Changeable, Creatable, OpenmrsObject, Retireable

All Known Subinterfaces:

AttributeType<OwningType>

All Known Implementing Classes:

BaseAttributeType, BaseChangeableOpenmrsMetadata, BaseCustomizableMetadata, BaseOpenmrsMetadata, CareSetting, ConceptAttributeType, ConceptClass, ConceptDatatype, ConceptMapType, ConceptReferenceTerm, ConceptSource, DiagnosisAttributeType, Drug, EncounterRole, EncounterType, Field, FieldType, Form, FormField, HL7Source, Location, LocationAttributeType, LocationTag, OrderAttributeType, OrderFrequency, OrderGroupAttributeType, OrderSet, OrderSetAttributeType, OrderSetMember, OrderType, PatientIdentifierType, PersonAttributeType, Privilege, Program, ProgramAttributeType, ProgramWorkflow, ProgramWorkflowState, Provider, ProviderAttributeType, RelationshipType, Role, SerializedObject, TaskDefinition, VisitAttributeType, VisitType

public interface OpenmrsMetadata
extends Auditable, Retireable

In OpenMRS, we distinguish between data and metadata within our data model. Metadata represent system and descriptive data such as data types — a relationship type or encounter type. Metadata are generally referenced by clinical data but don't represent patient-specific data themselves. OpenMRS objects that represent metadata should implement this interface.

Since:

1.5

See Also:

OpenmrsData, BaseChangeableOpenmrsMetadata

Method Summary

Modifier and Type	Method and Description
User	getChangedBy() Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
Date	getDateChanged() Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
String	getDescription()
String	getName()
void	setChangedBy(User changedBy) Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
void	setDateChanged(Date dateChanged) Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
void	setDescription(String description)
void	setName(String name)

Methods inherited from interface org.openmrs.Creatable

getCreator, getDateCreated, setCreator, setDateCreated

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Methods inherited from interface org.openmrs.Retireable

getDateRetired, getRetired, getRetiredBy, getRetireReason, isRetired, setDateRetired, setRetired, setRetiredBy, setRetireReason

Method Detail

getName

String getName()

Returns:

the name

setName

void setName(String name)

Parameters:

name - the name to set

getDescription

String getDescription()

Returns:

the description

setDescription

void setDescription(String description)

Parameters:

description - the description to set

getChangedBy

@Deprecated
User getChangedBy()

Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3

Specified by:

getChangedBy in interface Changeable

Returns:

User - the user who last changed the object

setChangedBy

@Deprecated
void setChangedBy(User changedBy)

Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3

Specified by:

setChangedBy in interface Changeable

Parameters:

changedBy - - the user who last changed the object

getDateChanged

@Deprecated
Date getDateChanged()

Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3

Specified by:

getDateChanged in interface Changeable

Returns:

Date - the date the object was last changed

setDateChanged

@Deprecated
void setDateChanged(Date dateChanged)

Deprecated. As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3

Specified by:

setDateChanged in interface Changeable

Parameters:

dateChanged - - the date the object was last changed