unidue.ub.statistics.alert

Class AlertControl

java.lang.Object

unidue.ub.statistics.alert.AlertControl

public class AlertControl
extends java.lang.Object

Holds the information for the alerting services

Version:

1

Author:

Eike Spielberg

Constructor Summary

Constructors

Constructor and Description
AlertControl() general constructor and initialization

Method Summary

Modifier and Type	Method and Description
void	addToOutput(org.jdom2.Element parent) attaches an XML version of the alert controls to the parent xml node
AlertControl	buildFromHttpRequest(javax.servlet.http.HttpServletRequest req) reads the parameters from the http request to modify the corresponding fields of the alert control.
java.lang.String	getAlertControl() returns the alert identifier
java.lang.String	getName() returns the name of the profile
java.lang.String	getNotationRange() returns the range of notations
java.lang.Boolean	getPerformAlert() returns the boolean, whether to send the alert for new data
java.lang.Boolean	getPerformReader() returns the boolean, whether to send the alert for new data
java.lang.String	getSubjectID() returns the subject ID
java.lang.Double	getThresholdQuotient() returns the the threshold for the quotient (number of requested items / number of lendable items)
java.lang.Double	getThresholdQuotientAlert() returns the the threshold for the quotient (number of requested items / number of lendable items) for the alerting service
AlertControl	readFromDisk(java.lang.String alertControl, java.lang.String who) builds the AlertControl by reading the file associated with the given alertControl from disk.
void	setAlertControl(java.lang.String alertControl) sets the alert identifier
void	setName(java.lang.String name) sets the name of the profile
void	setNotationRange(java.lang.String notationRange) sets the range of notations
void	setPerformAlert(java.lang.Boolean performAlert) sets the boolean whether or not to perform the alert
void	setPerformReader(java.lang.Boolean performReader) sets the boolean whether or not to perform the alert
void	setSubjectID(java.lang.String subjectID) sets the subject ID
void	setThresholdDuration(java.lang.Double thresholdQuotientAlert) sets the the threshold for the quotient (number of requested items / number of lendable items) for the alerting service
void	setThresholdQuotient(java.lang.Double thresholdQuotient) sets the threshold for the quotient (number of requested items / number of lendable items)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertControl

public AlertControl()

general constructor and initialization

Method Detail

setPerformAlert

public void setPerformAlert(java.lang.Boolean performAlert)

sets the boolean whether or not to perform the alert

Parameters:

performAlert - true, if the alert should be performed

setPerformReader

public void setPerformReader(java.lang.Boolean performReader)

sets the boolean whether or not to perform the alert

Parameters:

performAlert - true, if the alert should be performed

setThresholdQuotient

public void setThresholdQuotient(java.lang.Double thresholdQuotient)

sets the threshold for the quotient (number of requested items / number of lendable items)

Parameters:

thresholdQuotient - the thresholdQuotient to set

getNotationRange

public java.lang.String getNotationRange()

returns the range of notations

Returns:

the notationRange

setNotationRange

public void setNotationRange(java.lang.String notationRange)

sets the range of notations

Parameters:

notationRange - the notationRange to set

getAlertControl

public java.lang.String getAlertControl()

returns the alert identifier

Returns:

the alertControl

setAlertControl

public void setAlertControl(java.lang.String alertControl)

sets the alert identifier

Parameters:

alertControl - the alertControl to set

getSubjectID

public java.lang.String getSubjectID()

returns the subject ID

Returns:

the subjectID

setSubjectID

public void setSubjectID(java.lang.String subjectID)

sets the subject ID

Parameters:

subjectID - the subjectID to set

getName

public java.lang.String getName()

returns the name of the profile

Returns:

the name

setName

public void setName(java.lang.String name)

sets the name of the profile

Parameters:

name - the name to set

getPerformAlert

public java.lang.Boolean getPerformAlert()

returns the boolean, whether to send the alert for new data

Returns:

the perform

getPerformReader

public java.lang.Boolean getPerformReader()

returns the boolean, whether to send the alert for new data

Returns:

the perform

getThresholdQuotient

public java.lang.Double getThresholdQuotient()

returns the the threshold for the quotient (number of requested items / number of lendable items)

Returns:

the thresholdQuotient

getThresholdQuotientAlert

public java.lang.Double getThresholdQuotientAlert()

returns the the threshold for the quotient (number of requested items / number of lendable items) for the alerting service

Returns:

the thresholdDuration

setThresholdDuration

public void setThresholdDuration(java.lang.Double thresholdQuotientAlert)

sets the the threshold for the quotient (number of requested items / number of lendable items) for the alerting service

Parameters:

thresholdDuration - the thresholdDuration to set

buildFromHttpRequest

public AlertControl buildFromHttpRequest(javax.servlet.http.HttpServletRequest req)
                                  throws org.jdom2.JDOMException,
                                         java.io.IOException

reads the parameters from the http request to modify the corresponding fields of the alert control. If the corresponding alertControl string is given the corresponding file is read from disk.

Parameters:

req - the http-request

Returns:

AlertControl alert control

Throws:

org.jdom2.JDOMException - exception while parsing file

java.io.IOException - exception while reading file from disk

readFromDisk

public AlertControl readFromDisk(java.lang.String alertControl,
                                 java.lang.String who)
                          throws org.jdom2.JDOMException,
                                 java.io.IOException

builds the AlertControl by reading the file associated with the given alertControl from disk.

Parameters:

alertControl - the alertControl string

who - the actual username

Returns:

AlertControl alert control

Throws:

org.jdom2.JDOMException - exception while parsing file

java.io.IOException - exception while reading file from disk

addToOutput

public void addToOutput(org.jdom2.Element parent)

attaches an XML version of the alert controls to the parent xml node

Parameters:

parent - the parent xml node