SubscriptionResource (Silverpeas Core 6.3 API)

All Known Implementing Classes:

AbstractSubscriptionResource, CalendarSubscriptionResource, ComponentSubscriptionResource, NodeSubscriptionResource, PKSubscriptionResource, PublicationAliasSubscriptionResource, PublicationSubscriptionResource
```
public interface SubscriptionResource
```
A resource implied in a user subscription.

Since:

20/02/13

Author:

Yohann Chastagnier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getId()`	Gets the identifier of the resource aimed by a subscription.
`String`	`getInstanceId()`	Gets the instance identifier of the component instance that handles the resource in Silverpeas.
`<T extends WAPrimaryKey> T`	`getPK()`	Gets the Silverpeas Primary Key of the aimed resource.
`SubscriptionResourceType`	`getType()`	Gets the type of the resource aimed by the subscription

- Method Detail
  - getId
```
String getId()
```
    Gets the identifier of the resource aimed by a subscription.
    
    Returns:
    
    the unique identifier of a resource.
  - getType
```
SubscriptionResourceType getType()
```
    Gets the type of the resource aimed by the subscription
    
    Returns:
    
    a well predefined type of resource on which a subscription can be done.
  - getInstanceId
```
String getInstanceId()
```
    Gets the instance identifier of the component instance that handles the resource in Silverpeas.
    
    Returns:
    
    the unique identifier of a component instance.
  - getPK
```
<T extends WAPrimaryKey> T getPK()
```
    Gets the Silverpeas Primary Key of the aimed resource.
    
    Type Parameters:
    
    T - the concrete type of the key.
    
    Returns:
    
    the key identifying the resource in the data source used by Silverpeas to persist its data.