public interface NotificationService extends DriverService
NotificationQuery
,
eu.dentlib.domain.functionality.NotificationSchedule
,
NotificationEvent
,
NotificationResult
,
NotificationSubscription
,
NotificationServiceException
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.
|
identify, notify
SortedSet<String> getSupportedQueryLanguages()
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationQuery> getQueries(int pageNumber, int pageSize) throws NotificationServiceException
pageNumber
- the number of the page to retrievepageSize
- the size of the page to retrieveNotificationServiceException
- if any errors occurvoid addQuery(eu.dnetlib.domain.functionality.NotificationQuery query) throws NotificationServiceException
query
- the query to addNotificationServiceException
- if any errors occurvoid removeQuery(String queryId) throws NotificationServiceException
queryId
- the unique identifier of the query to removeNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.ResultPage executeQuery(String queryId, String resultId, Date fromDate, Date toDate, int limit, int offset) throws NotificationServiceException
queryId
- the unique identifier of the query to executeresultId
- the unique result identifier to usefromDate
- the from date to usetoDate
- the to date to uselimit
- the limit to useoffset
- the offset to useNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSchedule> getSchedules(int pageNumber, int pageSize) throws NotificationServiceException
pageNumber
- the number of the page to retrievepageSize
- the size of the page to retrieveNotificationServiceException
- if any errors occurvoid addSchedule(eu.dnetlib.domain.functionality.NotificationSchedule schedule) throws NotificationServiceException
schedule
- the schedule to addNotificationServiceException
- if any errors occurvoid enableSchedule(String queryId) throws NotificationServiceException
queryId
- the unique identifier of the query whose schedule to enableNotificationServiceException
- if any errors occurvoid disableSchedule(String queryId) throws NotificationServiceException
queryId
- the unique identifier of the query whose schedule to disableNotificationServiceException
- if any errors occurvoid removeSchedule(String queryId) throws NotificationServiceException
queryId
- the unique identifier of the query of the schedule to removeNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationEvent> getEvents(int pageNumber, int pageSize) throws NotificationServiceException
pageNumber
- the number of the page to retrievepageSize
- the size of the page to retrieveNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationResult> getResults(int pageNumber, int pageSize) throws NotificationServiceException
pageNumber
- the number of the page to retrievepageSize
- the size of the page to retrieveNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.NotificationResult getResult(String queryId, Date date, String resultId) throws NotificationServiceException
queryId
- the unique identifier of the query of the event of the result to retrievedate
- the date corresponding to the event of the result to retrieveresultId
- the unique identifier of the result to retrieveNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.NotificationResult getPreviousResult(String queryId, Date date, String resultId) throws NotificationServiceException
queryId
- the unique identifier of the query of the event of the result to retrievedate
- the date corresponding to the next event of the event whose result to retrieveresultId
- the unique identifier of the result to retrieveNotificationServiceException
- if any errors occureu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSubscription> getSubscriptions(int pageNumber, int pageSize) throws NotificationServiceException
pageNumber
- the number of the page to retrievepageSize
- the size of the page to retrieveNotificationServiceException
- if any errors occurvoid addSubscription(eu.dnetlib.domain.functionality.NotificationSubscription subscription) throws NotificationServiceException
subscription
- the subscription to addNotificationServiceException
- if any errors occurvoid enableSubscription(String queryId, URL alertService) throws NotificationServiceException
queryId
- the unique identifier of the query of the schedule of the subscription to enablealertService
- the URL of the alert service of the subscription to enableNotificationServiceException
- if any errors occurvoid disableSubscription(String queryId, URL alertService) throws NotificationServiceException
queryId
- the unique identifier of the query of the schedule of the subscription to disablealertService
- the URL of the alert service of the subscription to disableNotificationServiceException
- if any errors occurvoid removeSubscription(String queryId, URL alertService) throws NotificationServiceException
queryId
- the unique identifier of the query of the schedule of the subscription to removealertService
- the URL of the alert service of the subscription to removeNotificationServiceException
- if any errors occurCopyright © 2023. All rights reserved.