org.openmrs

Class BaseCustomizableMetadata<A extends Attribute>

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.BaseCustomizableMetadata<A>

Type Parameters:

A - the type of attribute held

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, Customizable<A>, OpenmrsMetadata, OpenmrsObject, Retireable

Direct Known Subclasses:

Location, OrderSet, Provider

@MappedSuperclass
public abstract class BaseCustomizableMetadata<A extends Attribute>
extends BaseChangeableOpenmrsMetadata
implements Customizable<A>

Extension of BaseOpenmrsMetadata for classes that support customization via user-defined attributes.

Since:

1.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseCustomizableMetadata()

Method Summary

Modifier and Type	Method and Description
void	addAttribute(A attribute) Adds an attribute.
Collection<A>	getActiveAttributes()
List<A>	getActiveAttributes(CustomValueDescriptor ofType)
Set<A>	getAttributes()
void	setAttribute(A attribute) Convenience method that voids all existing attributes of the given type, and sets this new one.
void	setAttributes(Set<A> attributes)

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Constructor Detail

BaseCustomizableMetadata

public BaseCustomizableMetadata()

Method Detail

getAttributes

public Set<A> getAttributes()

Specified by:

getAttributes in interface Customizable<A extends Attribute>

Returns:

all attributes (including voided ones)

See Also:

Customizable.getAttributes()

setAttributes

public void setAttributes(Set<A> attributes)

Parameters:

attributes - the attributes to set

getActiveAttributes

public Collection<A> getActiveAttributes()

Specified by:

getActiveAttributes in interface Customizable<A extends Attribute>

Returns:

non-voided attributes

See Also:

Customizable.getActiveAttributes()

getActiveAttributes

public List<A> getActiveAttributes(CustomValueDescriptor ofType)

Specified by:

getActiveAttributes in interface Customizable<A extends Attribute>

Returns:

non-voided attributes of the given type

See Also:

Customizable.getActiveAttributes(org.openmrs.customdatatype.CustomValueDescriptor)

addAttribute

public void addAttribute(A attribute)

Description copied from interface: Customizable

Adds an attribute.

Specified by:

addAttribute in interface Customizable<A extends Attribute>

See Also:

Customizable.addAttribute(Attribute)

setAttribute

public void setAttribute(A attribute)

Convenience method that voids all existing attributes of the given type, and sets this new one. Should void the attribute if an attribute with same attribute type already exists and the maxOccurs is set to 1 Should work for attributes with datatypes whose values are stored in other tables

Parameters:

attribute -