eu.dnetlib.clients.functionality.alert.ws

Class AlertWebServiceClient

java.lang.Object

eu.dnetlib.clients.ws.BaseWebServiceClient<AlertWebService>

eu.dnetlib.clients.functionality.alert.ws.AlertWebServiceClient

All Implemented Interfaces:

eu.dnetlib.api.DriverService, eu.dnetlib.api.functionality.AlertService

public class AlertWebServiceClient
extends BaseWebServiceClient<AlertWebService>
implements eu.dnetlib.api.functionality.AlertService

This class implements an alert service using an alert web service.

Author:

thanos@di.uoa.gr

See Also:

AlertService, AlertWebService, AlertServiceException

Field Summary

Fields inherited from class eu.dnetlib.clients.ws.BaseWebServiceClient

webService

Constructor Summary

Constructors

Constructor and Description
AlertWebServiceClient()

Method Summary

Modifier and Type	Method and Description
void	addSubscription(eu.dnetlib.domain.functionality.AlertSubscription subscription)
void	addTemplate(eu.dnetlib.domain.functionality.AlertTemplate template)
void	alert(URL notificationService, eu.dnetlib.domain.functionality.NotificationEvent event)
int	countAlertResults(URL notificationService, String queryId, Date date, String resultId)
void	disableSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber)
void	enableSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber)
eu.dnetlib.domain.functionality.ResultPage	getAlertResults(URL notificationService, String queryId, String resultId, Date fromDate, Date toDate, int limit, int offset)
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertSubscription>	getSubscriptions(int pageNumber, int pageSize)
SortedSet<eu.dnetlib.domain.functionality.AlertSubscription>	getSubscriptions(String alertMode, String subscriber, int limit, int offset)
SortedSet<String>	getSupportedAlertModes()
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertTemplate>	getTemplates(int pageNumber, int pageSize)
void	removeSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber)
void	removeTemplate(String templateId)

Methods inherited from class eu.dnetlib.clients.ws.BaseWebServiceClient

getWebService, identify, notify, setWebService, setWebService

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.dnetlib.api.DriverService

identify, notify

Constructor Detail

AlertWebServiceClient

public AlertWebServiceClient()

Method Detail

getSupportedAlertModes

public SortedSet<String> getSupportedAlertModes()

Specified by:

getSupportedAlertModes in interface eu.dnetlib.api.functionality.AlertService

getTemplates

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

Specified by:

getTemplates in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

addTemplate

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

Specified by:

addTemplate in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

removeTemplate

public void removeTemplate(String templateId)
                    throws eu.dnetlib.api.functionality.AlertServiceException

Specified by:

removeTemplate in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

getSubscriptions

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

Specified by:

getSubscriptions in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

getSubscriptions

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

Specified by:

getSubscriptions in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

addSubscription

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

Specified by:

addSubscription in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

enableSubscription

public void enableSubscription(String templateId,
                               URL notificationService,
                               String queryId,
                               String resultId,
                               String alertMode,
                               URI subscriber)
                        throws eu.dnetlib.api.functionality.AlertServiceException

Specified by:

enableSubscription in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

disableSubscription

public void disableSubscription(String templateId,
                                URL notificationService,
                                String queryId,
                                String resultId,
                                String alertMode,
                                URI subscriber)
                         throws eu.dnetlib.api.functionality.AlertServiceException

Specified by:

disableSubscription in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

removeSubscription

public void removeSubscription(String templateId,
                               URL notificationService,
                               String queryId,
                               String resultId,
                               String alertMode,
                               URI subscriber)
                        throws eu.dnetlib.api.functionality.AlertServiceException

Specified by:

removeSubscription in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

countAlertResults

public int countAlertResults(URL notificationService,
                             String queryId,
                             Date date,
                             String resultId)
                      throws eu.dnetlib.api.functionality.AlertServiceException

Specified by:

countAlertResults in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

getAlertResults

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

Specified by:

getAlertResults in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException

alert

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

Specified by:

alert in interface eu.dnetlib.api.functionality.AlertService

Throws:

eu.dnetlib.api.functionality.AlertServiceException