eu.dnetlib.api.functionality

Interface AlertService

All Superinterfaces:

DriverService

public interface AlertService
extends DriverService

This interface declares the available methods of alert service. Alert service is used to manage templates and subscriptions.

Author:

thanos@di.uoa.gr

See Also:

AlertTemplate, AlertSubscription, NotificationEvent, AlertServiceException

Method Summary

Modifier and Type	Method and Description
void	addSubscription(eu.dnetlib.domain.functionality.AlertSubscription subscription) Add a new subscription.
void	addTemplate(eu.dnetlib.domain.functionality.AlertTemplate template) Add a template.
void	alert(URL notificationService, eu.dnetlib.domain.functionality.NotificationEvent event) Alert this service about an event generated by a notification service.
int	countAlertResults(URL notificationService, String queryId, Date date, String resultId) Count the results of an alert.
void	disableSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber) Disable a subscription.
void	enableSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber) Enable a subscription.
eu.dnetlib.domain.functionality.ResultPage	getAlertResults(URL notificationService, String queryId, String resultId, Date fromDate, Date toDate, int limit, int offset) Retrieve the results of an alert.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertSubscription>	getSubscriptions(int pageNumber, int pageSize) Retrieve a page of subscriptions.
SortedSet<eu.dnetlib.domain.functionality.AlertSubscription>	getSubscriptions(String alerMode, String subscriber, int limit, int offset) Retrieve some subscriptions by alert mode and subscriber.
SortedSet<String>	getSupportedAlertModes() Retrieve all the supported modes in which alerts can be sent.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertTemplate>	getTemplates(int pageNumber, int pageSize) Retrieve a page of templates.
void	removeSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber) Remove a subscription.
void	removeTemplate(String templateId) Remove a template.

Methods inherited from interface eu.dnetlib.api.DriverService

identify, notify

Method Detail

getSupportedAlertModes

SortedSet<String> getSupportedAlertModes()

Retrieve all the supported modes in which alerts can be sent.

Returns:

a sorted set containing all the supported modes in which alerts can be sent

getTemplates

eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertTemplate> getTemplates(int pageNumber,
                                                                                                       int pageSize)
                                                                                                throws AlertServiceException

Retrieve a page of templates.

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing templates

Throws:

AlertServiceException - if any errors occur

addTemplate

void addTemplate(eu.dnetlib.domain.functionality.AlertTemplate template)
          throws AlertServiceException

Add a template.

Parameters:

template - the template to add

Throws:

AlertServiceException - if any errors occur

removeTemplate

void removeTemplate(String templateId)
             throws AlertServiceException

Remove a template.

Parameters:

templateId - the unique identifier of the template to remove

Throws:

AlertServiceException - if any errors occur

getSubscriptions

eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertSubscription> getSubscriptions(int pageNumber,
                                                                                                               int pageSize)
                                                                                                        throws AlertServiceException

Retrieve a page of subscriptions.

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing subscriptions

Throws:

AlertServiceException - if any errors occur

getSubscriptions

SortedSet<eu.dnetlib.domain.functionality.AlertSubscription> getSubscriptions(String alerMode,
                                                                              String subscriber,
                                                                              int limit,
                                                                              int offset)
                                                                       throws AlertServiceException

Retrieve some subscriptions by alert mode and subscriber.

Parameters:

alertMode - the alert mode of the subscriptions to retrieve

subscriber - the subscriber URI of the subscriptions to retrieve (prefix match)

limit - the maximum number of subscriptions to retrieve

offset - the offset to start at

Returns:

a list of subscriptions

Throws:

AlertServiceException - if any errors occur

addSubscription

void addSubscription(eu.dnetlib.domain.functionality.AlertSubscription subscription)
              throws AlertServiceException

Add a new subscription.

Parameters:

subscription - the subscription to add

Throws:

AlertServiceException - if any errors occur

enableSubscription

void enableSubscription(String templateId,
                        URL notificationService,
                        String queryId,
                        String resultId,
                        String alertMode,
                        URI subscriber)
                 throws AlertServiceException

Enable a subscription.

Parameters:

templateId - the unique identifier of the template of the subscription to enable

notificationService - the URL of the notification service of the subscription to enable

queryId - the unique identifier of the notification query of the subscription to enable

resultId - the unique identifier of the result of the subscription to enable

alertMode - the alert mode of the subscription to enable

subscriber - the URI of the subscriber of the subscription to enable

Throws:

AlertServiceException - if any errors occur

disableSubscription

void disableSubscription(String templateId,
                         URL notificationService,
                         String queryId,
                         String resultId,
                         String alertMode,
                         URI subscriber)
                  throws AlertServiceException

Disable a subscription.

Parameters:

templateId - the unique identifier of the template the subscription to disable

notificationService - the URL of the notification service of the subscription to disable

queryId - the unique identifier of the notification query of the subscription to disable

resultId - the unique identifier of the result of the subscription to disable

alertMode - the alert mode of the subscription to disable

subscriber - the URI of the subscriber of the subscription to disable

Throws:

AlertServiceException - if any errors occur

removeSubscription

void removeSubscription(String templateId,
                        URL notificationService,
                        String queryId,
                        String resultId,
                        String alertMode,
                        URI subscriber)
                 throws AlertServiceException

Remove a subscription.

Parameters:

templateId - the unique identifier of the template of the subscription to remove

notificationService - the URL of the notification service of the subscription to remove

queryId - the unique identifier of the notification query of the subscription to remove

resultId - the unique identifier of the result of the subscription to remove

alertMode - the alert mode of the subscription to remove

subscriber - the URI of the subscriber of the subscription to remove

Throws:

AlertServiceException - if any errors occur

countAlertResults

int countAlertResults(URL notificationService,
                      String queryId,
                      Date date,
                      String resultId)
               throws AlertServiceException

Count the results of an alert.

Parameters:

templateId - the unique identifier of the template of the alert results to count

notificationService - the URL of the notification service of the alert results to count

queryId - the unique identifier of the notification query of the alert results to count

date - the date that corresponds to the notification event of the alert results to count

resultId - the unique identifier of the notification result of the alert results to count

Returns:

the total number of the specified alert results

Throws:

AlertServiceException - if any errors occur

getAlertResults

eu.dnetlib.domain.functionality.ResultPage getAlertResults(URL notificationService,
                                                           String queryId,
                                                           String resultId,
                                                           Date fromDate,
                                                           Date toDate,
                                                           int limit,
                                                           int offset)
                                                    throws AlertServiceException

Retrieve the results of an alert.

Parameters:

notificationService - the URL of the notification service of the alert results to retrieve

queryId - the unique identfier of the notification query of the alert results to retrieve

resultId - the unique identifier of the notification result of the alert results to retrieve

fromDate - the date from which to retrieve alert results

toDate - the date up to which to retrieve alert results

limit - the maximum number of alert results to retrieve

offset - the offset to start at

Returns:

a result page

Throws:

AlertServiceException - if any errors occur

alert

void alert(URL notificationService,
           eu.dnetlib.domain.functionality.NotificationEvent event)
    throws AlertServiceException

Alert this service about an event generated by a notification service.

Parameters:

notificationService - the URL of the notification service

event - the notification event

Throws:

AlertServiceException - if any errors occur