IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.continuousquery
Interface ContinuousQueryNotificationEvent<KeyType,ValueType>

Type Parameters:
KeyType - Type of the key object in this event, from the key type used in the map being queried
ValueType - Type of the value object in this event, from the value type used in the map being queried

public interface ContinuousQueryNotificationEvent<KeyType,ValueType>

An interface which defines notification metadata that is sent to continuous query listeners when the result set of a defined continous query changes.

Since:
8.6

Nested Class Summary
static class ContinuousQueryNotificationEvent.Reason
          Indicates the reason a notification event has occurred for this cache entry.
 
Method Summary
 KeyType getKey()
          Retrieve the key of the cache entry that triggered this notification
 ContinuousQueryNotificationEvent.Reason getReason()
          Retrieve the reason for this notification event
 SessionHandle getSessionHandle()
          Retrieve a SessionHandle object which can be used to retrieve the cache entry that triggered this notification.
 ValueType getValue()
          Retrieve the value of the cache entry that triggered this notification
 boolean isKeysOnly()
          If true, this notification only includes the key of the matching cache entry.
 

Method Detail

getKey

KeyType getKey()
Retrieve the key of the cache entry that triggered this notification

Returns:
the cache entry key

getValue

ValueType getValue()
Retrieve the value of the cache entry that triggered this notification

Returns:
the cache entry value

getSessionHandle

SessionHandle getSessionHandle()
Retrieve a SessionHandle object which can be used to retrieve the cache entry that triggered this notification.

Returns:
the SessionHandle for the partition that owns the cache entry.
See Also:
Session.setSessionHandle(SessionHandle)

getReason

ContinuousQueryNotificationEvent.Reason getReason()
Retrieve the reason for this notification event

Returns:
the Reason enum

isKeysOnly

boolean isKeysOnly()
If true, this notification only includes the key of the matching cache entry. If false, this notification also includes the value

Returns:
whether or not this notification includes the cache value.
See Also:
getValue()

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.