org.openmrs
Interface Retireable

All Superinterfaces:

OpenmrsObject

All Known Subinterfaces:

OpenmrsMetadata

All Known Implementing Classes:

ActiveListType, BaseOpenmrsMetadata, Concept, ConceptClass, ConceptComplex, ConceptDatatype, ConceptDerived, ConceptNumeric, ConceptSource, Drug, EncounterType, Field, FieldType, Form, FormField, HL7Source, Location, LocationTag, MimeType, OrderType, PatientIdentifierType, PersonAttributeType, Privilege, Program, ProgramWorkflow, ProgramWorkflowState, RelationshipType, ReportSchema, Role, SerializedObject, TaskDefinition, User

public interface Retireable
extends OpenmrsObject

In OpenMRS, data are rarely fully deleted (purged) from the system; rather, they are either voided or retired. When existing data remain valid but should no longer be used for new entries, they are retired. Typically this applies to metadata (see OpenmrsMetadata). For example, an encounter form type or a patient attribute type may no longer be valid but cannot be removed because there are (and may be in perpetuity) data previously collected using these metadata. Making these metadata Retirable allows them to be retired, meaning that existing references remain valid but future references are not allowed.

Since:

1.5

See Also:

OpenmrsMetadata, Voidable

Method Summary

java.util.Date	getDateRetired()
User	getRetiredBy()
java.lang.String	getRetireReason()
java.lang.Boolean	isRetired()
void	setDateRetired(java.util.Date dateRetired)
void	setRetired(java.lang.Boolean retired)
void	setRetiredBy(User retiredBy)
void	setRetireReason(java.lang.String retireReason)

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Method Detail

isRetired

java.lang.Boolean isRetired()

Returns:

Boolean - whether of not this object is retired

setRetired

void setRetired(java.lang.Boolean retired)

Parameters:

retired - - whether of not this object is retired

getRetiredBy

User getRetiredBy()

Returns:

User - the user who retired the object

setRetiredBy

void setRetiredBy(User retiredBy)

Parameters:

retiredBy - - the user who retired the object

getDateRetired

java.util.Date getDateRetired()

Returns:

Date - the date the object was retired

setDateRetired

void setDateRetired(java.util.Date dateRetired)

Parameters:

dateRetired - - the date the object was retired

getRetireReason

java.lang.String getRetireReason()

Returns:

String - the reason the object was retired

setRetireReason

void setRetireReason(java.lang.String retireReason)

Parameters:

retireReason - - the reason the object was retired