org.openmrs.notification

Class AlertRecipient

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.notification.AlertRecipient

All Implemented Interfaces:

Serializable, OpenmrsObject

@Entity
public class AlertRecipient
extends BaseOpenmrsObject

This class is essentially a wrapper for the user object. The alert is assigned to each recipient. A recipient then has either "read" the alert or has not.

See Also:

Alert, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AlertRecipient() Default empty constructor
AlertRecipient(Alert a) Initializes a recipient with the given alert
AlertRecipient(Alert a, User recipient) Initializes a recipient with the given alert and recipient/user
AlertRecipient(User user, Boolean read) Initializes a recipient with the given user

Method Summary

Modifier and Type	Method and Description
Alert	getAlert()
Boolean	getAlertRead()
Date	getDateChanged()
Integer	getId()
User	getRecipient()
Boolean	isAlertRead()
void	setAlert(Alert alert)
void	setAlertRead(Boolean alertRead)
void	setDateChanged(Date dateChanged)
void	setId(Integer id)
void	setRecipient(User user)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertRecipient

public AlertRecipient()

Default empty constructor

AlertRecipient

public AlertRecipient(Alert a)

Initializes a recipient with the given alert

AlertRecipient

public AlertRecipient(Alert a,
                      User recipient)

Initializes a recipient with the given alert and recipient/user

AlertRecipient

public AlertRecipient(User user,
                      Boolean read)

Initializes a recipient with the given user

Parameters:

read -

user -

Method Detail

getAlert

public Alert getAlert()

Returns:

Returns the alert.

setAlert

public void setAlert(Alert alert)

Parameters:

alert - The alert to set.

getDateChanged

public Date getDateChanged()

Returns:

Returns the date this alert was changed

setDateChanged

public void setDateChanged(Date dateChanged)

Parameters:

dateChanged - The date this alert was changed

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

isAlertRead

public Boolean isAlertRead()

Returns:

Returns the read status

getAlertRead

public Boolean getAlertRead()

See Also:

getAlertRead()

setAlertRead

public void setAlertRead(Boolean alertRead)

Parameters:

alertRead - The alertRead to set.

getRecipient

public User getRecipient()

Returns:

Returns the recipient/user.

setRecipient

public void setRecipient(User user)

Parameters:

user - The recipient/user to set.

getId

public Integer getId()

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)