ISubscriptionInfo (server-common-api)

All Known Subinterfaces:

ISubscription
```
public interface ISubscriptionInfo
```
This represents the relationship between a Thing interested in events (usually a Principal) and Thing that generates events (usually an information resource). It has a 'from' and a 'to'.
- The 'from' identifies the resource that will generate events.
  - from.id - Thing ID. A ThingID that specifies ThingType but leave the instance ID as 0 will subscribe to all Things of the specified type.
  - from.criteria[] - list of criterion specifying property and operation. Optional.
    - from.criteria[].property - ThingID of Relation that defines this property
    - from.criteria[].from - boolean defining whether the Relation is from or to the specified Thing. A value of true means 'from'.
    - from.criteria[].operation - operations to listen for as bitfield (see IEventOperation)
- The 'to' represents where notifications will be delivered.
  - to.thing - Thing ID of user or group interested in events
  - to.deliveryMode[] - Delivery mechanisms. Multiple values are separated by a comma.
    - "email" If the target is an IUser, an e-mail will be sent
    - "portal" If the target is an IUser, a notification will be placed in their Inbox
    - "thing" The target Thing will be instantiated and its onMessage method will be called
    - "queue" The message will be forwarded to the target ID via a JMS Queue
    - "topic" The message will be forwarded to the target ID via a JMS Topic
See Also:

ISubscription

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAILY_DELIVERY` Notifications are delivered as a daily digest
`static int`	`DELIVERY_TYPE_MASK` Mast for all delivery types
`static int`	`DIGEST_DELIVERY_MASK` Mast for all digest type deliveries
`static int`	`DISABLED_BY_SYSTEM`
`static int`	`DISABLED_BY_USER`
`static int`	`EMAIL_DELIVERY` Notification is delivered by email, if one is defined for the subscriber
`static int`	`ENABLED`
`static int`	`HTTP_DELIVERY`
`static int`	`IM_DELIVERY`
`static int`	`PORTAL_DELIVERY` Notification is delivered to subscriber portal inbox
`static int`	`THING_DELIVERY` Notification is delivered as a thing event
`static int`	`WEEKLY_DELIVERY` Notifications are delivered as a weekly digest

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IThingID`	`findCriterion(ICriterion criterion)` Searches by value.
`List<ICriterion>`	`getCriteriaList()` Array of ICriterion
`int`	`getDeliveryModes()` Returns delivery mode set for this subscription.
`IThingID`	`getOwner()`
`IThingID`	`getResource()` The information resource ID that generates events
`int`	`getStatus()` Determines whether the subscription is enabled or disabled.
`ISubscriber`	`getSubscriber()` The principal interested in events.
`boolean`	`hasCriterion(ICriterion criterion)` Searches by comparing Criterion ThingID
`boolean`	`hasCriterion(IThingID criterion)` Searches by comparing Criterion ThingID
`boolean`	`isRecursive()` Indicates if this is a recursive subscription
`void`	`setCriteriaIDs(IThingIDList criteria)` Note: this is an expensive operation.
`void`	`setDeliveryModes(int modes)` save delivery mode.
`void`	`setOwner(IThingID owner)` Enables or disables the subscription
`void`	`setRecursive(boolean recursive)` Sets if this is a recursive subscription
`void`	`setResource(IThingID sourceID)` Set the event resource ThingID.
`void`	`setStatus(int status)` Enables or disables the subscription
`void`	`setSubscriber(ISubscriber target)` Set the subscriber.

- Field Detail
  - EMAIL_DELIVERY
```
static final int EMAIL_DELIVERY
```
    Notification is delivered by email, if one is defined for the subscriber
    
    See Also:
    
    Constant Field Values
  - PORTAL_DELIVERY
```
static final int PORTAL_DELIVERY
```
    Notification is delivered to subscriber portal inbox
    
    See Also:
    
    Constant Field Values
  - THING_DELIVERY
```
static final int THING_DELIVERY
```
    Notification is delivered as a thing event
    
    See Also:
    
    Constant Field Values
  - HTTP_DELIVERY
```
static final int HTTP_DELIVERY
```
    See Also:
    
    Constant Field Values
  - IM_DELIVERY
```
static final int IM_DELIVERY
```
    See Also:
    
    Constant Field Values
  - DELIVERY_TYPE_MASK
```
static final int DELIVERY_TYPE_MASK
```
    Mast for all delivery types
    
    See Also:
    
    Constant Field Values
  - DAILY_DELIVERY
```
static final int DAILY_DELIVERY
```
    Notifications are delivered as a daily digest
    
    See Also:
    
    Constant Field Values
  - WEEKLY_DELIVERY
```
static final int WEEKLY_DELIVERY
```
    Notifications are delivered as a weekly digest
    
    See Also:
    
    Constant Field Values
  - DIGEST_DELIVERY_MASK
```
static final int DIGEST_DELIVERY_MASK
```
    Mast for all digest type deliveries
    
    See Also:
    
    Constant Field Values
  - ENABLED
```
static final int ENABLED
```
    See Also:
    
    Constant Field Values
  - DISABLED_BY_USER
```
static final int DISABLED_BY_USER
```
    See Also:
    
    Constant Field Values
  - DISABLED_BY_SYSTEM
```
static final int DISABLED_BY_SYSTEM
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getStatus
```
int getStatus()
       throws MetaException
```
    Determines whether the subscription is enabled or disabled.
    
    Throws:
    
    MetaException
  - setStatus
```
void setStatus(int status)
        throws MetaException
```
    Enables or disables the subscription
    
    Throws:
    
    MetaException
    
    See Also:
    
    ISubscriptionStatus
  - getResource
```
IThingID getResource()
              throws MetaException
```
    The information resource ID that generates events
    
    Throws:
    
    MetaException
  - getSubscriber
```
ISubscriber getSubscriber()
                   throws MetaException
```
    The principal interested in events.
    
    Throws:
    
    MetaException
  - setResource
```
void setResource(IThingID sourceID)
          throws MetaException
```
    Set the event resource ThingID.
    
    Throws:
    
    MetaException
  - setSubscriber
```
void setSubscriber(ISubscriber target)
            throws MetaException
```
    Set the subscriber.
    
    Throws:
    
    MetaException
  - getCriteriaList
```
List<ICriterion> getCriteriaList()
                          throws MetaException
```
    Array of ICriterion
    
    Throws:
    
    MetaException
  - setCriteriaIDs
```
void setCriteriaIDs(IThingIDList criteria)
             throws MetaException
```
    Note: this is an expensive operation.
    
    Throws:
    
    MetaException
  - getOwner
```
IThingID getOwner()
           throws MetaException
```
    Throws:
    
    MetaException
  - setOwner
```
void setOwner(IThingID owner)
       throws MetaException
```
    Enables or disables the subscription
    
    Throws:
    
    MetaException
    
    See Also:
    
    ISubscriptionStatus
  - hasCriterion
```
boolean hasCriterion(ICriterion criterion)
              throws MetaException
```
    Searches by comparing Criterion ThingID
    
    Throws:
    
    MetaException
  - hasCriterion
```
boolean hasCriterion(IThingID criterion)
              throws MetaException
```
    Searches by comparing Criterion ThingID
    
    Throws:
    
    MetaException
  - findCriterion
```
IThingID findCriterion(ICriterion criterion)
                throws MetaException
```
    Searches by value. All values must match.
    
    Throws:
    
    MetaException
  - setDeliveryModes
```
void setDeliveryModes(int modes)
               throws MetaException
```
    save delivery mode. The mode is a bit setting. Each bit represents a type of delivery agent
    
    Throws:
    
    MetaException
  - getDeliveryModes
```
int getDeliveryModes()
              throws MetaException
```
    Returns delivery mode set for this subscription. See delivery modes constants
    
    Throws:
    
    MetaException
  - isRecursive
```
boolean isRecursive()
             throws MetaException
```
    Indicates if this is a recursive subscription
    
    Returns:
    
    Throws:
    
    MetaException
  - setRecursive
```
void setRecursive(boolean recursive)
           throws MetaException
```
    Sets if this is a recursive subscription
    
    Parameters:
    
    recursive -
    
    Throws:
    
    MetaException

Interface ISubscriptionInfo

Field Summary

Method Summary

Field Detail

EMAIL_DELIVERY

PORTAL_DELIVERY

THING_DELIVERY

HTTP_DELIVERY

IM_DELIVERY

DELIVERY_TYPE_MASK

DAILY_DELIVERY

WEEKLY_DELIVERY

DIGEST_DELIVERY_MASK

ENABLED

DISABLED_BY_USER

DISABLED_BY_SYSTEM

Method Detail

getStatus

setStatus

getResource

getSubscriber

setResource

setSubscriber

getCriteriaList

setCriteriaIDs

getOwner

setOwner

hasCriterion

hasCriterion

findCriterion

setDeliveryModes

getDeliveryModes

isRecursive

setRecursive