eu.dnetlib.clients.functionality.notification.ws

Interface NotificationWebService

All Superinterfaces:

eu.dnetlib.common.rmi.BaseService, eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.NotificationService>, DriverWebService<eu.dnetlib.api.functionality.NotificationService>

All Known Implementing Classes:

NotificationWebServiceImpl

public interface NotificationWebService
extends DriverWebService<eu.dnetlib.api.functionality.NotificationService>

This interface declares the available methods of a notification service which is accessible as a web service.

Author:

thanos@di.uoa.gr

See Also:

NotificationService, NotificationWebServiceException

Method Summary

Modifier and Type	Method and Description
void	addQuery(eu.dnetlib.domain.functionality.NotificationQuery query) Add a query.
void	addSchedule(eu.dnetlib.domain.functionality.NotificationSchedule schedule) Add a schedule.
void	addSubscription(eu.dnetlib.domain.functionality.NotificationSubscription subscription) Add a subscription.
void	disableSchedule(String queryId) Disable a schedule
void	disableSubscription(String queryId, URL alertService) Disable a subscription.
void	enableSchedule(String queryId) Enable a schedule
void	enableSubscription(String queryId, URL alertService) Enable a subscription.
eu.dnetlib.domain.functionality.ResultPage	executeQuery(String queryId, String resultId, Date fromDate, Date toDate, int limit, int offset) Execute a query and return the generated result.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationEvent>	getEvents(int pageNumber, int pageSize) Retrieve a page of events.
eu.dnetlib.domain.functionality.NotificationResult	getPreviousResult(String queryId, Date date, String resultId) Retrieve a result of the previous event of an event of a query.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationQuery>	getQueries(int pageNumber, int pageSize) Retrieve a page of queries.
eu.dnetlib.domain.functionality.NotificationResult	getResult(String queryId, Date date, String resultId) Retrieve a result of an event of a query.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationResult>	getResults(int pageNumber, int pageSize) Retrieve a page of results.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSchedule>	getSchedules(int pageNumber, int pageSize) Retrieve a page of schedules
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSubscription>	getSubscriptions(int pageNumber, int pageSize) Retrieve a page of subscriptions
SortedSet<String>	getSupportedQueryLanguages() Retrieve all the supported languages in which queries can be expressed.
void	removeQuery(String queryId) Remove a query.
void	removeSchedule(String queryId) Remove a schedule.
void	removeSubscription(String queryId, URL alertService) Remove a subscription.

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Method Detail

getSupportedQueryLanguages

SortedSet<String> getSupportedQueryLanguages()

Retrieve all the supported languages in which queries can be expressed.

Returns:

a set containing all the supported languages in which queries can be expressed

getQueries

eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationQuery> getQueries(int pageNumber,
                                                                                                         int pageSize)
                                                                                                  throws NotificationWebServiceException

Retrieve a page of queries.

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing queries

Throws:

NotificationWebServiceException - if any errors occur

addQuery

void addQuery(eu.dnetlib.domain.functionality.NotificationQuery query)
       throws NotificationWebServiceException

Add a query.

Parameters:

query - the query to add

Throws:

NotificationWebServiceException - if any errors occur

removeQuery

void removeQuery(String queryId)
          throws NotificationWebServiceException

Remove a query.

Parameters:

queryId - the unique identifier of the query to remove

Throws:

NotificationWebServiceException - if any errors occur

executeQuery

eu.dnetlib.domain.functionality.ResultPage executeQuery(String queryId,
                                                        String resultId,
                                                        Date fromDate,
                                                        Date toDate,
                                                        int limit,
                                                        int offset)
                                                 throws NotificationWebServiceException

Execute a query and return the generated result.

Parameters:

queryId - the unique identifier of the query to execute

resultId - the unique result identifier to use

fromDate - the from date to use

toDate - the to date to use

limit - the limit to use

offset - the offset to use

Returns:

a result page containing the generated results

Throws:

NotificationWebServiceException - if any errors occur

getSchedules

eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSchedule> getSchedules(int pageNumber,
                                                                                                              int pageSize)
                                                                                                       throws NotificationWebServiceException

Retrieve a page of schedules

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing schedules

Throws:

NotificationWebServiceException - if any errors occur

addSchedule

void addSchedule(eu.dnetlib.domain.functionality.NotificationSchedule schedule)
          throws NotificationWebServiceException

Add a schedule.

Parameters:

schedule - the schedule to add

Throws:

NotificationWebServiceException - if any errors occur

enableSchedule

void enableSchedule(String queryId)
             throws NotificationWebServiceException

Enable a schedule

Parameters:

queryId - the unique identifier of the query whose schedule to enable

Throws:

NotificationWebServiceException - if any errors occur

disableSchedule

void disableSchedule(String queryId)
              throws NotificationWebServiceException

Disable a schedule

Parameters:

queryId - the unique identifier of the query whose schedule to disable

Throws:

NotificationWebServiceException - if any errors occur

removeSchedule

void removeSchedule(String queryId)
             throws NotificationWebServiceException

Remove a schedule.

Parameters:

queryId - the unique identifier of the query of the schedule to remove

Throws:

NotificationWebServiceException - if any errors occur

getEvents

eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationEvent> getEvents(int pageNumber,
                                                                                                        int pageSize)
                                                                                                 throws NotificationWebServiceException

Retrieve a page of events.

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing events

Throws:

NotificationWebServiceException - if any errors occur

getResults

eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationResult> getResults(int pageNumber,
                                                                                                          int pageSize)
                                                                                                   throws NotificationWebServiceException

Retrieve a page of results.

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing results

Throws:

NotificationWebServiceException - if any errors occur

getResult

eu.dnetlib.domain.functionality.NotificationResult getResult(String queryId,
                                                             Date date,
                                                             String resultId)
                                                      throws NotificationWebServiceException

Retrieve a result of an event of a query.

Parameters:

queryId - the unique identifier of the query of the event of the result to retrieve

date - the date corresponding to the event of the result to retrieve

resultId - the unique identifier of the result to retrieve

Returns:

the specified result of the specified event of the specified query or null if no such result exists

Throws:

NotificationWebServiceException - if any errors occur

getPreviousResult

eu.dnetlib.domain.functionality.NotificationResult getPreviousResult(String queryId,
                                                                     Date date,
                                                                     String resultId)
                                                              throws NotificationWebServiceException

Retrieve a result of the previous event of an event of a query.

Parameters:

queryId - the unique identifier of the query of the event of the result to retrieve

date - the date corresponding to the next event of the event whose result to retrieve

resultId - the unique identifier of the result to retrieve

Returns:

the specified result of the previous event of the specified event of the specified query or null if no such result exists

Throws:

NotificationWebServiceException - if any errors occur

getSubscriptions

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

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:

NotificationWebServiceException - if any errors occur

addSubscription

void addSubscription(eu.dnetlib.domain.functionality.NotificationSubscription subscription)
              throws NotificationWebServiceException

Add a subscription.

Parameters:

subscription - the subscription to add

Throws:

NotificationWebServiceException - if any errors occur

enableSubscription

void enableSubscription(String queryId,
                        URL alertService)
                 throws NotificationWebServiceException

Enable a subscription.

Parameters:

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

alertService - the URL of the alert service to enable

Throws:

NotificationWebServiceException - if any errors occur

disableSubscription

void disableSubscription(String queryId,
                         URL alertService)
                  throws NotificationWebServiceException

Disable a subscription.

Parameters:

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

alertService - the URL of the alert service to disable

Throws:

NotificationWebServiceException - if any errors occur

removeSubscription

void removeSubscription(String queryId,
                        URL alertService)
                 throws NotificationWebServiceException

Remove a subscription.

Parameters:

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

alertService - the URL of the alert service to remove

Throws:

NotificationWebServiceException - if any errors occur