org.openmrs.attribute

Interface Attribute<AT extends AttributeType,OT extends Customizable<?>>

Type Parameters:

AT - the AttributeType for this Attribute

OT - the type this attribute can belong to

All Superinterfaces:

Auditable, OpenmrsData, OpenmrsObject, SingleCustomValue<AT>, Voidable

All Known Implementing Classes:

BaseAttribute, LocationAttribute, ProviderAttribute, VisitAttribute

public interface Attribute<AT extends AttributeType,OT extends Customizable<?>>
extends OpenmrsData, SingleCustomValue<AT>

Common interface for user-defined attribute that is are added to a base class. Every attribute corresponds to a AttributeType, which defines, among other things, whether it is required, whether it may repeat, and how it is serialized and deserialized for storage. These attribute types are intended for use cases that would involve adding custom columns to the base table in a less generic system. For example Visit has VisitAttributes (which implements Attribute) that are defined by VisitAttributeTypes.

Since:

1.9

See Also:

AttributeType, Customizable, AttributeHandler

Method Summary

Modifier and Type	Method and Description
AT	getAttributeType()
OT	getOwner()
void	setOwner(OT owner) Sets the owner of this attribute

Methods inherited from interface org.openmrs.Auditable

getChangedBy, getCreator, getDateChanged, getDateCreated, setChangedBy, setCreator, setDateChanged, setDateCreated

Methods inherited from interface org.openmrs.Voidable

getDateVoided, getVoidedBy, getVoidReason, isVoided, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Methods inherited from interface org.openmrs.customdatatype.SingleCustomValue

getDescriptor, getValue, getValueReference, isDirty, setValue, setValueReferenceInternal

Method Detail

getOwner

OT getOwner()

Returns:

the owner that this attribute belongs to

setOwner

void setOwner(OT owner)

Sets the owner of this attribute

Parameters:

owner -

getAttributeType

AT getAttributeType()

Returns:

the AttributeType that controls this attribute's behavior