org.opennms.web.admin.users.parsers

Class NotificationInfo

java.lang.Object

org.opennms.web.admin.users.parsers.NotificationInfo

All Implemented Interfaces:

Cloneable

public class NotificationInfo
extends Object
implements Cloneable

This class stores notification information for a user

Since:

1.8.1

Version:

1.1.1.1

Author:

Jason Johns , OpenNMS , Jason Johns , OpenNMS

Constructor Summary

Constructors

Constructor and Description
NotificationInfo() Default constructor, initializes the member variables

Method Summary

Modifier and Type	Method and Description
void	addDutySchedule(DutySchedule aSchedule) This method adds a duty schedule
Object	clone() clone
int	getDutyScheduleCount() Returns the number of DutySchedule object for a user
List<DutySchedule>	getDutySchedules() Returns the full list of DutySchedules
String	getEmail() Returns the email address
String	getNumericalPin() Returns the numerical pin string
String	getNumericalService() Returns the numerical service string
String	getPagerEmail() Returns the pager email address
String	getTextPin() Returns the text pin string
String	getTextService() Returns the text service string
String	getXMPPAddress() Returns the XMPP address
boolean	isOnDuty(Calendar aTime) Returns a boolean indicating if the user is on duty at the specified time.
void	setDutySchedule(List<DutySchedule> someSchedules) This method sets a full list of duty schedules for a user
void	setEmail(String anEmail) Sets the email address
void	setNumericalPin(String aPin) Sets the numerical pin
void	setNumericalService(String aService) Sets the numerical service string
void	setPagerEmail(String anEmail) Sets the pager email address
void	setTextPin(String aPin) Sets the text pin string
void	setTextService(String aService) Sets the text service string
void	setXMPPAddress(String anAddress) Sets the XMPP address
String	toString() A String representation of the notification information, primarily used for debugging.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationInfo

public NotificationInfo()

Default constructor, initializes the member variables

Method Detail

clone

public Object clone()

clone

Overrides:

clone in class Object

Returns:

a Object object.

setEmail

public void setEmail(String anEmail)

Sets the email address

Parameters:

anEmail - the email address

setPagerEmail

public void setPagerEmail(String anEmail)

Sets the pager email address

Parameters:

anEmail - the new email address

setXMPPAddress

public void setXMPPAddress(String anAddress)

Sets the XMPP address

Parameters:

anAddress - the new XMPP address

setNumericalService

public void setNumericalService(String aService)

Sets the numerical service string

Parameters:

aService - the numerical service

setNumericalPin

public void setNumericalPin(String aPin)

Sets the numerical pin

Parameters:

aPin - the numerical pin

setTextService

public void setTextService(String aService)

Sets the text service string

Parameters:

aService - the text service

setTextPin

public void setTextPin(String aPin)

Sets the text pin string

Parameters:

aPin - the text pin

addDutySchedule

public void addDutySchedule(DutySchedule aSchedule)

This method adds a duty schedule

Parameters:

aSchedule - a new duty schedule to associate with a user

setDutySchedule

public void setDutySchedule(List<DutySchedule> someSchedules)

This method sets a full list of duty schedules for a user

Parameters:

someSchedules - a list of DutySchedule objects for a user

getEmail

public String getEmail()

Returns the email address

Returns:

the email address

getPagerEmail

public String getPagerEmail()

Returns the pager email address

Returns:

the pager email address

getXMPPAddress

public String getXMPPAddress()

Returns the XMPP address

Returns:

the XMPP address

getNumericalService

public String getNumericalService()

Returns the numerical service string

Returns:

the numerical service

getNumericalPin

public String getNumericalPin()

Returns the numerical pin string

Returns:

the numerical pin

getTextService

public String getTextService()

Returns the text service string

Returns:

the text service

getTextPin

public String getTextPin()

Returns the text pin string

Returns:

the text pin

getDutyScheduleCount

public int getDutyScheduleCount()

Returns the number of DutySchedule object for a user

Returns:

the number of DutySchedules

getDutySchedules

public List<DutySchedule> getDutySchedules()

Returns the full list of DutySchedules

Returns:

the full list of DutySchedules

isOnDuty

public boolean isOnDuty(Calendar aTime)

Returns a boolean indicating if the user is on duty at the specified time.

Parameters:

aTime - a time to see if the user is on duty

Returns:

true if the user is on duty, false otherwise

toString

public String toString()

A String representation of the notification information, primarily used for debugging.

Overrides:

toString in class Object

Returns:

String representation of the notification information