Allergy (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.BaseChangeableOpenmrsData
    - - org.openmrs.BaseFormRecordableOpenmrsData
      - org.openmrs.Allergy

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, FormRecordable, OpenmrsData, OpenmrsObject, Voidable
```
@Entity
public class Allergy
extends BaseFormRecordableOpenmrsData
```
Represent allergy

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID
- Fields inherited from class org.openmrs.BaseFormRecordableOpenmrsData
  FORM_NAMESPACE_PATH_MAX_LENGTH, FORM_NAMESPACE_PATH_SEPARATOR, formNamespaceAndPath
- Fields inherited from class org.openmrs.BaseOpenmrsData
  creator

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`Allergy()` Default constructor
`Allergy(Patient patient, Allergen allergen, Concept severity, String comments, List<AllergyReaction> reactions)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addReaction(AllergyReaction reaction)` Adds a new allergy reaction
`void`	`copy(Allergy allergy)` Copies all property values, apart from the id and uuid, from the given allergy into this object
`Allergen`	`getAllergen()`
`AllergenType`	`getAllergenType()`
`Integer`	`getAllergyId()`
`AllergyReaction`	`getAllergyReaction(Integer allergyReactionId)` Gets an allergy reaction with a given id
`String`	`getComment()` Deprecated. as of 2.3.0, replaced by `getComments()`
`String`	`getComments()`
`Date`	`getDateLastUpdated()`
`Encounter`	`getEncounter()` Basic property getter for encounter
`Integer`	`getId()`
`Patient`	`getPatient()`
`AllergyReaction`	`getReaction(Concept concept)` Gets the reaction with a given concept
`String`	`getReactionNonCoded()`
`List<AllergyReaction>`	`getReactions()`
`Concept`	`getSeverity()`
`boolean`	`hasSameAllergen(Allergy allergy)` Checks if we have the same allergen as that in the given allergy
`boolean`	`hasSameValues(Allergy allergy)` Checks if this allergy has the same values as a given one.
`boolean`	`removeReaction(AllergyReaction reaction)` Removes an allergy reaction
`void`	`setAllergen(Allergen allergen)`
`void`	`setAllergenType(AllergenType allergenType)` set the allergyType of the Allergy
`void`	`setAllergenType(String type)` set the allergyType of the Allergy.
`void`	`setAllergyId(Integer allergyId)`
`void`	`setComment(String comment)` Deprecated. as of 2.3.0, replaced by `setComments(String)`
`void`	`setComments(String comments)`
`void`	`setEncounter(Encounter encounter)` Basic property setter for encounter
`void`	`setId(Integer allergyId)`
`void`	`setPatient(Patient patient)`
`void`	`setReactions(List<AllergyReaction> reactions)`
`void`	`setSeverity(Concept severity)`

Methods inherited from class org.openmrs.BaseFormRecordableOpenmrsData
getFormFieldNamespace, getFormFieldNamespace, getFormFieldPath, getFormFieldPath, getFormNamespaceAndPath, getFormNamespaceAndPath, setFormField, setFormNamespaceAndPath

Methods inherited from class org.openmrs.BaseOpenmrsData
getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

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
getUuid, setUuid

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Allergy
```
public Allergy()
```
    Default constructor
  - Allergy
```
public Allergy(Patient patient,
               Allergen allergen,
               Concept severity,
               String comments,
               List<AllergyReaction> reactions)
```
    Parameters:
    
    patient - the patient to set.
    
    allergen - the allergen to set
    
    severity - the severity to set
    
    comments - the comment to set
    
    reactions - the reactions to set
- Method Detail
  - getAllergyId
```
public Integer getAllergyId()
```
    Returns:
    
    the allergyId
  - setAllergyId
```
public void setAllergyId(Integer allergyId)
```
    Parameters:
    
    allergyId - the allergyId to set
  - getId
```
public Integer getId()
```
    Returns:
    
    id - The unique Identifier for the object
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer allergyId)
```
    Parameters:
    
    allergyId - - The unique Identifier for the object
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)
  - getPatient
```
public Patient getPatient()
```
    Returns:
    
    Returns the patient
  - setPatient
```
public void setPatient(Patient patient)
```
    Parameters:
    
    patient - the patient to set
  - getAllergenType
```
public AllergenType getAllergenType()
```
    Returns:
    
    the allergyType
  - setAllergenType
```
public void setAllergenType(AllergenType allergenType)
```
    set the allergyType of the Allergy
    
    Parameters:
    
    allergenType - the allergyType to set
  - setAllergenType
```
public void setAllergenType(String type)
```
    set the allergyType of the Allergy. Here the allergy type will be chosen from the enum values in the AllergenType, according to the given String type.
    
    Parameters:
    
    type - the allergyType to set
  - getAllergen
```
public Allergen getAllergen()
```
    Returns:
    
    Returns the allergen
  - setAllergen
```
public void setAllergen(Allergen allergen)
```
    Parameters:
    
    allergen - the allergen to set
  - getSeverity
```
public Concept getSeverity()
```
    Returns:
    
    Returns the severity
  - setSeverity
```
public void setSeverity(Concept severity)
```
    Parameters:
    
    severity - the severity to set
  - getComment
```
@Deprecated
public String getComment()
```
    Deprecated. as of 2.3.0, replaced by getComments()
    
    Returns:
    
    Returns the comment
  - setComment
```
@Deprecated
public void setComment(String comment)
```
    Deprecated. as of 2.3.0, replaced by setComments(String)
    
    Parameters:
    
    comment - the comment to set
  - getComments
```
public String getComments()
```
    Returns:
    
    Returns the comments
    
    Since:
    
    2.3.0
  - setComments
```
public void setComments(String comments)
```
    Parameters:
    
    comments - the comments to set
    
    Since:
    
    2.3.0
  - getReactions
```
public List<AllergyReaction> getReactions()
```
    Returns:
    
    Returns the reactions
  - setReactions
```
public void setReactions(List<AllergyReaction> reactions)
```
    Parameters:
    
    reactions - the reactions to set
  - addReaction
```
public boolean addReaction(AllergyReaction reaction)
```
    Adds a new allergy reaction
    
    Parameters:
    
    reaction - the reaction to add
    
    Returns:
    
    true if the reaction was added, else false
  - removeReaction
```
public boolean removeReaction(AllergyReaction reaction)
```
    Removes an allergy reaction
    
    Parameters:
    
    reaction - the reaction to remove
    
    Returns:
    
    true if the reaction was found and removed, else false.
  - getDateLastUpdated
```
public Date getDateLastUpdated()
```
  - hasSameValues
```
public boolean hasSameValues(Allergy allergy)
```
    Checks if this allergy has the same values as a given one.
    
    Parameters:
    
    allergy - the allergy whose values to compare with
    
    Returns:
    
    true if the values match, else false
  - getAllergyReaction
```
public AllergyReaction getAllergyReaction(Integer allergyReactionId)
```
    Gets an allergy reaction with a given id
    
    Parameters:
    
    allergyReactionId - the allergy reaction id
    
    Returns:
    
    the allergy reaction with a matching id
  - copy
```
public void copy(Allergy allergy)
```
    Copies all property values, apart from the id and uuid, from the given allergy into this object
    
    Parameters:
    
    allergy - the allergy whose property values to copy
    
    Throws:
    
    InvocationTargetException
    
    IllegalAccessException
  - getReactionNonCoded
```
public String getReactionNonCoded()
```
    Returns:
    
    Returns the reactionNonCoded
  - getReaction
```
public AllergyReaction getReaction(Concept concept)
```
    Gets the reaction with a given concept
    
    Parameters:
    
    concept - the concept
    
    Returns:
    
    the reaction if any exists
  - hasSameAllergen
```
public boolean hasSameAllergen(Allergy allergy)
```
    Checks if we have the same allergen as that in the given allergy
    
    Parameters:
    
    allergy - the given allergy whose allergen to check
    
    Returns:
    
    true if the same, else false
  - getEncounter
```
public Encounter getEncounter()
```
    Basic property getter for encounter
    
    Returns:
    
    encounter - the associated encounter
    
    Since:
    
    2.5.0
  - setEncounter
```
public void setEncounter(Encounter encounter)
```
    Basic property setter for encounter
    
    Parameters:
    
    encounter - - the encounter to set
    
    Since:
    
    2.5.0

Class Allergy

Field Summary

Fields inherited from class org.openmrs.BaseFormRecordableOpenmrsData

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseFormRecordableOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

Allergy

Allergy

Method Detail

getAllergyId

setAllergyId

getId

setId

getPatient

setPatient

getAllergenType

setAllergenType

setAllergenType

getAllergen

setAllergen

getSeverity

setSeverity

getComment

setComment

getComments

setComments

getReactions

setReactions

addReaction

removeReaction

getDateLastUpdated

hasSameValues

getAllergyReaction

copy

getReactionNonCoded

getReaction

hasSameAllergen

getEncounter

setEncounter