CopaServer
Change of Plan Application
 All Classes Functions Pages
Classes | Public Member Functions | Protected Member Functions | List of all members
unicopa.copa.server.notification.NotificationService Class Referenceabstract

A service which notifies clients about an update on a SingleEvent. More...

Inheritance diagram for unicopa.copa.server.notification.NotificationService:
Inheritance graph
Collaboration diagram for unicopa.copa.server.notification.NotificationService:
Collaboration graph

Classes

enum  NotificationEvent
 Events clients can be notified about. More...
 

Public Member Functions

 NotificationService (CopaSystemContext context)
 Create a new instance of a notification service. More...
 
abstract void notifyClients (SingleEventUpdate update)
 Notify all clients that registered for this kind of notification and for receiving this update. More...
 
abstract void notifyClient (NotificationEvent event, int userID)
 Notify a specific client. More...
 

Protected Member Functions

CopaSystemContext getContext ()
 Obtain the system context. More...
 

Detailed Description

A service which notifies clients about an update on a SingleEvent.

Author
Felix Wiemuth

Constructor & Destructor Documentation

unicopa.copa.server.notification.NotificationService.NotificationService ( CopaSystemContext  context)

Create a new instance of a notification service.

Parameters
dbservicethe database service the notification service should use to obtain additional information

Member Function Documentation

CopaSystemContext unicopa.copa.server.notification.NotificationService.getContext ( )
protected

Obtain the system context.

See Also
unicopa.copa.server.CopaSystemContext
Returns
abstract void unicopa.copa.server.notification.NotificationService.notifyClient ( NotificationEvent  event,
int  userID 
)
pure virtual

Notify a specific client.

Parameters
eventthe notification event to inform about
userIDthe recipient of the notification event

Implemented in unicopa.copa.server.notification.EmailNotificationService, and unicopa.copa.server.notification.GoogleCloudNotificationService.

abstract void unicopa.copa.server.notification.NotificationService.notifyClients ( SingleEventUpdate  update)
pure virtual

Notify all clients that registered for this kind of notification and for receiving this update.

Parameters
updatethe SingleEventUpdate to inform about

Implemented in unicopa.copa.server.notification.EmailNotificationService, and unicopa.copa.server.notification.GoogleCloudNotificationService.


The documentation for this class was generated from the following file: