eu.dnetlib.domain.functionality

Class AlertSubscription

java.lang.Object

eu.dnetlib.domain.functionality.AlertSubscription

All Implemented Interfaces:

Comparable<AlertSubscription>

public class AlertSubscription
extends Object
implements Comparable<AlertSubscription>

This class represents a subscription to a topic of the alert service.

Author:

thanos@di.uoa.gr

See Also:

eu.dnetlib.api.functionality.AlertService, eu.dnetlib.functionality.alert.alerter.Alerter, AlertTopic, AlertTemplate

Constructor Summary

Constructors

Constructor and Description
AlertSubscription() Construct a new alert subscription with template identifier, notification service, query identifier, result identifier, alert mode and subscriber set to null and enabled set to false.
AlertSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber, boolean enabled) Construct a new alert subscription.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AlertSubscription subscription)
boolean	equals(Object object)
String	getAlertMode() Get the alert mode of this subscription.
URL	getNotificationService() Get the notification service of the topic of this subscription.
String	getQueryId() Set the notification query of the topic of this subscription.
String	getResultId() Get the notification result of the topic of this subscription.
URI	getSubscriber() Get the subscriber of this subscription.
String	getTemplateId() Get the template of the topic of this subscription.
int	hashCode()
boolean	isEnabled() Check if this subscription is enabled.
void	setAlertMode(String alertMode) Set the alert mode of this subscription
void	setEnabled(boolean enabled) Set the enabled status of this subscription.
void	setNotificationService(URL notificationService) Set the notification service of the topic of this subscription.
void	setQueryId(String queryId) Set the notification query of the topic of this subscription.
void	setResultId(String resultId) Set the notification result of the topic of this subscription.
void	setSubscriber(URI subscriber) Set the subscriber of this subscription.
void	setTemplateId(String templateId) Set the template of the topic of this subscription.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertSubscription

public AlertSubscription(String templateId,
                         URL notificationService,
                         String queryId,
                         String resultId,
                         String alertMode,
                         URI subscriber,
                         boolean enabled)

Construct a new alert subscription.

Parameters:

templateId - the unique identifier of the template of the topic of this subscription

notificationService - the URL of notification service of the topic of this subscription

queryId - the unique identifier of the notification service of the topic of this subscription

resultId - the unique identifier of the notification result of the topic of this subscription

alertMode - the alert mode of this subscription

subscriber - the URI of the subscriber of this topic

enabled - true if this subscription is currently enabled, false if it is currently disabled

AlertSubscription

public AlertSubscription()

Construct a new alert subscription with template identifier, notification service, query identifier, result identifier, alert mode and subscriber set to null and enabled set to false.

Method Detail

getTemplateId

public String getTemplateId()

Get the template of the topic of this subscription.

Returns:

the unique identifier of the template of the topic of this subscription

setTemplateId

public void setTemplateId(String templateId)

Set the template of the topic of this subscription.

Parameters:

templateId - the unique identifier of the template of the topic of this subscription

getNotificationService

public URL getNotificationService()

Get the notification service of the topic of this subscription.

Returns:

the URL of the notification service of the topic of this subscription

setNotificationService

public void setNotificationService(URL notificationService)

Set the notification service of the topic of this subscription.

Parameters:

notificationService - the URL of the notification service of the topic of this subscription

getQueryId

public String getQueryId()

Set the notification query of the topic of this subscription.

Returns:

the unique identifier of the notification query of the topic of this subscription

setQueryId

public void setQueryId(String queryId)

Set the notification query of the topic of this subscription.

Parameters:

queryId - the unique identifier of the notification query of the topic of this subscription

getResultId

public String getResultId()

Get the notification result of the topic of this subscription.

Returns:

the resultId the unique identifier of the notification result of the topic of this subscription

setResultId

public void setResultId(String resultId)

Set the notification result of the topic of this subscription.

Parameters:

resultId - the unique identifier of the notification result of the topic of this subscription

getAlertMode

public String getAlertMode()

Get the alert mode of this subscription.

Returns:

the alert mode of this subscription

setAlertMode

public void setAlertMode(String alertMode)

Set the alert mode of this subscription

Parameters:

alertMode - the alert mode of this subscription

getSubscriber

public URI getSubscriber()

Get the subscriber of this subscription.

Returns:

the URI of the subscriber of this subscription

setSubscriber

public void setSubscriber(URI subscriber)

Set the subscriber of this subscription.

Parameters:

subscriber - the URI of the subscriber of this subscription

isEnabled

public boolean isEnabled()

Check if this subscription is enabled.

Returns:

true if this subscription is currently enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Set the enabled status of this subscription.

Parameters:

enabled - true to enable this subscription, false to disable it

compareTo

public int compareTo(AlertSubscription subscription)

Specified by:

compareTo in interface Comparable<AlertSubscription>

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object