org.benow.web.subscription
Interface SubscriptionService

All Superinterfaces:
org.benow.java.spec.Markup, org.benow.service.Service
All Known Implementing Classes:
SubscriptionServiceImpl

public interface SubscriptionService
extends org.benow.service.Service


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.benow.java.spec.Markup
org.benow.java.spec.Markup.ParamName, org.benow.java.spec.Markup.ReturnDescription
 
Method Summary
 java.util.List<Subscription> getSubscriptions()
          Get all subscriptions of current user
 Subscription subscribe(Subscribable obj)
          Subscribe to all types of notifications for the given object.
 Subscription subscribe(Subscribable obj, Subscription.SubscriptionType type)
          Subscribe current user to given object with given type
 void unsubscribe(Subscribable obj)
          Unsubscribe current user from given object
 void unsubscribeAll()
          Unsubscribe current user from all objects
 

Method Detail

subscribe

Subscription subscribe(Subscribable obj)
Subscribe to all types of notifications for the given object.

Parameters:
toSubscribeTo -
Returns:

subscribe

Subscription subscribe(Subscribable obj,
                       Subscription.SubscriptionType type)
Subscribe current user to given object with given type

Parameters:
toSubscribeTo -
type -

unsubscribe

void unsubscribe(Subscribable obj)
                 throws org.benow.repository.NoSuchObjectException
Unsubscribe current user from given object

Parameters:
toUnsubscribeFrom -
Throws:
org.benow.repository.NoSuchObjectException

unsubscribeAll

void unsubscribeAll()
Unsubscribe current user from all objects


getSubscriptions

java.util.List<Subscription> getSubscriptions()
Get all subscriptions of current user

Returns: