Subscription (OpenICF Framework 1.5.20.15 Documentation)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable
```
public interface Subscription
extends java.io.Closeable
```
A SubscriptionHandler represents a subscription to an asynchronous event channel.

Since:

1.5

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`	Unsubscribes this `SubscriptionHandler` from receiving messages sent to this channel.
`java.lang.Object`	`getReturnValue()`	Get the return value associated with establishing this subscription.
`boolean`	`isUnsubscribed()`	Indicates whether this `Subscription` is currently unsubscribed.

- Method Detail
  - close
```
void close()
```
    Unsubscribes this SubscriptionHandler from receiving messages sent to this channel.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    See Also:
    
    ConnectorEventSubscriptionApiOp.subscribe(ObjectClass, Filter, Observer, OperationOptions), SyncEventSubscriptionApiOp.subscribe(ObjectClass, SyncToken, Observer, OperationOptions)
  - isUnsubscribed
```
boolean isUnsubscribed()
```
    Indicates whether this Subscription is currently unsubscribed.
    
    Returns:
    
    true if this Subscription is currently unsubscribed, false otherwise
  - getReturnValue
```
java.lang.Object getReturnValue()
```
    Get the return value associated with establishing this subscription.
    
    Returns:
    
    return value