Package org.silverpeas.core.subscription

Interface ResourceSubscriptionService

All Known Implementing Classes:

AbstractCalendarSubscriptionService, AbstractPublicationSubscriptionService, AbstractResourceSubscriptionService, DefaultResourceSubscriptionService

public interface ResourceSubscriptionService

This interface defines some services for which it exists one default implementations and potentially one per component.

Author:

Yohann Chastagnier

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ResourceSubscriptionService.Constants	Some predefined constants to use by Silverpeas components to support identical behaviours.

Method Summary

Modifier and Type	Method	Description
SubscriptionSubscriberList	getSubscribersOfComponent(String componentInstanceId)	Gets all subscribers registered on a component. This service does not look at resources handled by the component but just explicit component subscriptions.
SubscriptionSubscriberList	getSubscribersOfComponentAndTypedResource(String componentInstanceId, SubscriptionResourceType resourceType, String resourceId, SubscriberDirective... directives)	Gets all subscribers concerned by a specified resource represented by the given resource type and identifier. The inheritance of subscription is handled by this method.
SubscriptionSubscriberList	getSubscribersOfSubscriptionResource(SubscriptionResource subscriptionResource, SubscriberDirective... directives)	Gets all subscribers concerned by a specified subscription resource. The inheritance of subscription is handled by this method.

Method Detail

getSubscribersOfComponent

SubscriptionSubscriberList getSubscribersOfComponent(String componentInstanceId)

Gets all subscribers registered on a component.
This service does not look at resources handled by the component but just explicit component subscriptions.

Parameters:

componentInstanceId - the identifier of the component instance from which subscription are requested.

Returns:

an instance of SubscriptionSubscriberList that represents a collection of SubscriptionSubscriber decorated with useful tool methods.

getSubscribersOfComponentAndTypedResource

SubscriptionSubscriberList getSubscribersOfComponentAndTypedResource(String componentInstanceId,
                                                                     SubscriptionResourceType resourceType,
                                                                     String resourceId,
                                                                     SubscriberDirective... directives)

Gets all subscribers concerned by a specified resource represented by the given resource type and identifier.
The inheritance of subscription is handled by this method. So if the aimed subscription resource has a parent subscription resource, subscribers of both of them are returned.

Parameters:

componentInstanceId - the identifier of the component instance from which subscription are requested.

resourceType - the type of the aimed resource.

resourceId - the identifier of the aimed resource.

directives - some directive to apply when it is necessary.

Returns:

an instance of SubscriptionSubscriberList that represents a collection of SubscriptionSubscriber decorated with useful tool methods.

getSubscribersOfSubscriptionResource

SubscriptionSubscriberList getSubscribersOfSubscriptionResource(SubscriptionResource subscriptionResource,
                                                                SubscriberDirective... directives)

Gets all subscribers concerned by a specified subscription resource.
The inheritance of subscription is handled by this method. So if the aimed subscription resource has a parent subscription resource, subscribers of both of them are returned.

Parameters:

subscriptionResource - the instance of subscription resource.

Returns:

an instance of SubscriptionSubscriberList that represents a collection of SubscriptionSubscriber decorated with useful tool methods.