org.carewebframework.vista.ui.notification

Class AbstractNotification

java.lang.Object

org.carewebframework.vista.ui.notification.AbstractNotification

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Notification, ScheduledNotification

public abstract class AbstractNotification
extends Object
implements Serializable

Base class for notifications.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractNotification()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	canDelete() Returns true if this notification can be deleted.
int	findParam(String param) Locate a parameter from name/value pairs in extra info.
org.carewebframework.vista.mbroker.FMDate	getDeliveryDate() Returns the delivery date of this notification.
abstract String	getDfn() Returns the DFN of the associated patient.
String	getDisplayText() Returns the display text for this notification.
String[]	getExtraInfo() Returns extra information associated with this notification.
List<String>	getMessage() Returns the message associated with this notification.
String	getParam(String param) Extract a parameter from name/value pairs in extra info.
String	getPatientName() Returns the name of the associated patient.
abstract Priority	getPriority() Returns the priority of this notification.
String	getSenderName() Returns the name of the sender of this notification.
String	getSubject() Returns the subject line of this notification.
boolean	hasPatient() Returns true if the notification has a patient association.
abstract boolean	isActionable() Returns true if this notification has an associated action.
protected void	setDeliveryDate(org.carewebframework.vista.mbroker.FMDate deliveryDate) Sets the delivery date of this notification.
protected abstract void	setDfn(String dfn) Sets the DFN of the associated patient.
protected void	setExtraInfo(String[] extraInfo) Sets extra information associated with this notification.
protected void	setMessage(List<String> message) Sets the message associated with this notification.
protected int	setParam(String param, Object value) Sets the value for a parameter in extra info.
protected void	setPatientName(String patientName) Sets the name of the associated patient.
protected abstract void	setPriority(Priority priority) Sets the priority of this notification.
protected void	setSenderName(String senderName) Sets the name of the sender of this notification.
protected void	setSubject(String subject) Sets the subject line of this notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractNotification

public AbstractNotification()

Method Detail

isActionable

public abstract boolean isActionable()

Returns true if this notification has an associated action.

Returns:

True if actionable.

canDelete

public abstract boolean canDelete()

Returns true if this notification can be deleted.

Returns:

True if notification can be deleted.

getPriority

public abstract Priority getPriority()

Returns the priority of this notification.

Returns:

Notification priority.

setPriority

protected abstract void setPriority(Priority priority)

Sets the priority of this notification.

Parameters:

priority - Notification priority.

getDfn

public abstract String getDfn()

Returns the DFN of the associated patient.

Returns:

DFN of the associated patient (null if no patient association).

setDfn

protected abstract void setDfn(String dfn)

Sets the DFN of the associated patient.

Parameters:

dfn - DFN of the associated patient (null if no patient association).

getPatientName

public String getPatientName()

Returns the name of the associated patient.

Returns:

Name of the associated patient (null if no patient association).

setPatientName

protected void setPatientName(String patientName)

Sets the name of the associated patient.

Parameters:

patientName - Name of the associated patient (null if no patient association).

hasPatient

public boolean hasPatient()

Returns true if the notification has a patient association.

Returns:

True if there is a patient association.

getSubject

public String getSubject()

Returns the subject line of this notification.

Returns:

Subject line.

setSubject

protected void setSubject(String subject)

Sets the subject line of this notification.

Parameters:

subject - Subject line.

getDeliveryDate

public org.carewebframework.vista.mbroker.FMDate getDeliveryDate()

Returns the delivery date of this notification.

Returns:

Delivery date.

setDeliveryDate

protected void setDeliveryDate(org.carewebframework.vista.mbroker.FMDate deliveryDate)

Sets the delivery date of this notification.

Parameters:

deliveryDate - Delivery date.

getSenderName

public String getSenderName()

Returns the name of the sender of this notification.

Returns:

Sender name.

setSenderName

protected void setSenderName(String senderName)

Sets the name of the sender of this notification.

Parameters:

senderName - Sender name.

getExtraInfo

public String[] getExtraInfo()

Returns extra information associated with this notification. Format is type-specific.

Returns:

Extra information.

setExtraInfo

protected void setExtraInfo(String[] extraInfo)

Sets extra information associated with this notification. Format is type-specific.

Parameters:

extraInfo - Extra information.

getMessage

public List<String> getMessage()

Returns the message associated with this notification.

Returns:

The associated message. May be null.

setMessage

protected void setMessage(List<String> message)

Sets the message associated with this notification.

Parameters:

message - The associated message. May be null.

findParam

public int findParam(String param)

Locate a parameter from name/value pairs in extra info.

Parameters:

param - Parameter name.

Returns:

Index of parameter in extra info, or -1 if not found.

getParam

public String getParam(String param)

Extract a parameter from name/value pairs in extra info.

Parameters:

param - Parameter name.

Returns:

Parameter value, or null if not found.

setParam

protected int setParam(String param,
           Object value)

Sets the value for a parameter in extra info.

Parameters:

param - Parameter name.

value - Parameter value (null to remove).

Returns:

Index of parameter in extra info.

getDisplayText

public String getDisplayText()

Returns the display text for this notification.

Returns:

Display text.