org.openmrs

Interface Voidable

All Superinterfaces:

OpenmrsObject

All Known Subinterfaces:

Attribute<AT,OT>, OpenmrsData

All Known Implementing Classes:

Allergy, BaseAttribute, BaseChangeableOpenmrsData, BaseCustomizableData, BaseFormRecordableOpenmrsData, BaseOpenmrsData, Cohort, CohortMembership, ConceptAttribute, ConceptName, ConceptNameTag, Condition, Diagnosis, DiagnosisAttribute, DrugOrder, Encounter, EncounterProvider, LocationAttribute, MedicationDispense, Obs, Order, OrderAttribute, OrderGroup, OrderGroupAttribute, OrderSetAttribute, Patient, PatientIdentifier, PatientProgram, PatientProgramAttribute, PatientState, Person, PersonAddress, PersonAttribute, PersonMergeLog, PersonName, ProviderAttribute, ReferralOrder, Relationship, ServiceOrder, TestOrder, Visit, VisitAttribute

public interface Voidable
extends OpenmrsObject

In OpenMRS, data are rarely fully deleted (purged) from the system; rather, they are either voided or retired. When data can be removed (effectively deleted from the user's perspective), then they are voidable. Voided data are no longer valid and references from other non-voided data are not valid. For example, when duplicate patient records are merged, the record that is not kept is voided (invalidated). Unlike Retireable, voiding data invalidates any data referencing them. e.g., when a patient is voided, all observations for that patient must be voided as well.

Since:

1.5

See Also:

OpenmrsData, Retireable

Method Summary

Modifier and Type	Method and Description
Date	getDateVoided()
Boolean	getVoided()
User	getVoidedBy()
String	getVoidReason()
Boolean	isVoided() Deprecated. as of 2.0, use getVoided()
void	setDateVoided(Date dateVoided)
void	setVoided(Boolean voided)
void	setVoidedBy(User voidedBy)
void	setVoidReason(String voidReason)

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Method Detail

isVoided

@Deprecated
Boolean isVoided()

Deprecated. as of 2.0, use getVoided()

Returns:

Boolean - whether of not this object is voided

getVoided

Boolean getVoided()

Returns:

true if this object is voided and otherwise false

setVoided

void setVoided(Boolean voided)

Parameters:

voided - - whether of not this object is voided

getVoidedBy

User getVoidedBy()

Returns:

User - the user who voided the object

setVoidedBy

void setVoidedBy(User voidedBy)

Parameters:

voidedBy - - the user who voided the object

getDateVoided

Date getDateVoided()

Returns:

Date - the date the object was voided

setDateVoided

void setDateVoided(Date dateVoided)

Parameters:

dateVoided - - the date the object was voided

getVoidReason

String getVoidReason()

Returns:

String - the reason the object was voided

setVoidReason

void setVoidReason(String voidReason)

Parameters:

voidReason - - the reason the object was voided