Subscription (Silverpeas Core 6.4 API)

All Known Implementing Classes:

AbstractSubscription, AbstractSubscriptionBean, CalendarSubscription, CalendarSubscriptionBean, ComponentSubscription, ComponentSubscriptionBean, NodeSubscription, NodeSubscriptionBean, PKSubscription, PublicationAliasSubscription, PublicationSubscription, PublicationSubscriptionBean
```
public interface Subscription
```
A subscription of a user or a group to be notified about changes of a given resource in Silverpeas.

Author:

ehugonnet

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Date`	`getCreationDate()`	Gets the date at which the subscription has been done.
`String`	`getCreatorId()`	Gets the unique identifier of the user that did the subscription.
`SubscriptionResource`	`getResource()`	Gets the resource on which the subscription is.
`SubscriptionSubscriber`	`getSubscriber()`	Gets the subscriber.
`SubscriptionMethod`	`getSubscriptionMethod()`	What is the method used to subscribe to the resource?

- Method Detail
  - getResource
```
SubscriptionResource getResource()
```
    Gets the resource on which the subscription is.
    
    Returns:
    
    a SubscriptionResource instance representing a resource in Silverpeas.
  - getSubscriber
```
SubscriptionSubscriber getSubscriber()
```
    Gets the subscriber. It can be either a user or a group of users. In the case of a group of users, the subscription was done by a user with management rights on the resource.
    
    Returns:
    
    a SubscriptionSubscriber instance representing either the user or the group of users that have subscribed to the given resource.
  - getSubscriptionMethod
```
SubscriptionMethod getSubscriptionMethod()
```
    What is the method used to subscribe to the resource? It can be either by the subscriber himself or it can be forced by another user with management rights.
    
    Returns:
    
    a SubscriptionMethod instance representing the method used to create this subscription.
  - getCreatorId
```
String getCreatorId()
```
    Gets the unique identifier of the user that did the subscription. It can be the identifier of the subscriber or, for forced subscription, it is the identifier of a user with management rights.
    
    Returns:
    
    the unique identifier of a user.
  - getCreationDate
```
Date getCreationDate()
```
    Gets the date at which the subscription has been done.
    
    Returns:
    
    a date.