Package org.openremote.model.notification

Class Notification

java.lang.Object

org.openremote.model.notification.Notification

public class Notification
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Notification.Source
static class	Notification.Target
static enum	Notification.TargetType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEADER_SOURCE
static final String	HEADER_SOURCE_ID
protected AbstractNotificationMessage	message
protected String	name
protected RepeatFrequency	repeatFrequency
protected String	repeatInterval
protected List<Notification.Target>	targets

Constructor Summary

Constructors

Constructor	Description
Notification()
Notification(String name, AbstractNotificationMessage message, List<Notification.Target> targets, RepeatFrequency repeatFrequency, String repeatInterval)

Method Summary

Modifier and Type	Method	Description
AbstractNotificationMessage	getMessage()
String	getName()
RepeatFrequency	getRepeatFrequency()
String	getRepeatInterval()
List<Notification.Target>	getTargets()
Notification	setMessage(AbstractNotificationMessage message)
Notification	setName(String name)
Notification	setRepeatFrequency(RepeatFrequency repeatFrequency)	This applies a fixed time window to a notification i.e.
Notification	setRepeatInterval(String repeatInterval)	This applies a sliding time window to a notification using an ISO8601 duration string i.e.
void	setTargets(List<Notification.Target> targets)
void	setTargets(Notification.Target... targets)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

HEADER_SOURCE

public static final String HEADER_SOURCE

HEADER_SOURCE_ID

public static final String HEADER_SOURCE_ID

name

protected String name

message

protected AbstractNotificationMessage message

repeatFrequency

protected RepeatFrequency repeatFrequency

repeatInterval

protected String repeatInterval

targets

protected List<Notification.Target> targets

Constructor Details

Notification

public Notification()

Notification

public Notification(String name,
 AbstractNotificationMessage message,
 List<Notification.Target> targets,
 RepeatFrequency repeatFrequency,
 String repeatInterval)

Method Details

getName

public String getName()

setName

public Notification setName(String name)

getMessage

public AbstractNotificationMessage getMessage()

setMessage

public Notification setMessage(AbstractNotificationMessage message)

getTargets

public List<Notification.Target> getTargets()

setTargets

public void setTargets(Notification.Target... targets)

setTargets

public void setTargets(List<Notification.Target> targets)

getRepeatFrequency

public RepeatFrequency getRepeatFrequency()

setRepeatFrequency

public Notification setRepeatFrequency(RepeatFrequency repeatFrequency)

This applies a fixed time window to a notification i.e. RepeatFrequency.HOURLY would mean that a notification sent at 10:59 can then be resent at 11:00.

getRepeatInterval

public String getRepeatInterval()

setRepeatInterval

public Notification setRepeatInterval(String repeatInterval)

This applies a sliding time window to a notification using an ISO8601 duration string i.e. a value of PT1H would mean has it been at least 1hr since the notification was last sent.

toString

public String toString()

Overrides:

toString in class Object