oracle.ifs.fdk
Class ItemSetInvalidator

java.lang.Object
oracle.ifs.fdk.ItemSetInvalidator

All Implemented Interfaces:

ItemSetInvalidationListener

public class ItemSetInvalidator

extends java.lang.Object

implements ItemSetInvalidationListener

The interface used to be notified when one or more of a set of items are changed by any session.

Constructor Summary

ItemSetInvalidator(FdkSession session)
Construct an ItemSetInvalidator.

Method Summary

void	invalidate() Receive notification that one or more items specified when this ItemSetInvalidatorListener was registered has been invalidated.
boolean	isInvalidated() Check to see if any of the prevously specified dependent items have been invalidated.
void	register(java.util.List items) Register the ItemSetInvalidator.
void	register(long[] items) Register the ItemSetInvalidator.
void	reset() Reset the ItemSetInvalidator to begin watching for invalidations for the previously specified set of items.
void	reset(java.util.List items) Reset the ItemSetInvalidator to begin watching for invalidations based on the newly specified set of items.
void	reset(long[] items) Reset the ItemSetInvalidator to begin watching for invalidations based on the newly specified set of items.
void	unregister() Unregister the ItemSetInvalidator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ItemSetInvalidator

public ItemSetInvalidator(FdkSession session)
                   throws FdkException

Construct an ItemSetInvalidator.

Parameters:

session - the session context

Throws:

FdkException - if the operation fails.

Method Detail

invalidate

public void invalidate()

Receive notification that one or more items specified when this ItemSetInvalidatorListener was registered has been invalidated.

Specified by:

invalidate in interface ItemSetInvalidationListener

isInvalidated

public boolean isInvalidated()
                      throws FdkException

Check to see if any of the prevously specified dependent items have been invalidated.

Returns:

true if one or more items have been invalidated.

Throws:

FdkException - if the operation fails.

register

public void register(java.util.List items)
              throws FdkException

Register the ItemSetInvalidator.

This registers the invalidator for the specified set of items, so that a subsequent call to isInvalidated will detect the case where one or more items have been invalidated since the last interogation.

Parameters:

items - the items that will be watched for invalidations

Throws:

FdkException - if the operation fails.

register

public void register(long[] items)
              throws FdkException

Register the ItemSetInvalidator.

This registers the invalidator for the specified set of items, so that a subsequent call to isInvalidated will detect the case where one or more items have been invalidated since the last interogation.

Parameters:

items - the items that will be watched for invalidations

Throws:

FdkException - if the operation fails.

reset

public void reset()
           throws FdkException

Reset the ItemSetInvalidator to begin watching for invalidations for the previously specified set of items.

Throws:

FdkException - if the operation fails.

reset

public void reset(java.util.List items)
           throws FdkException

Reset the ItemSetInvalidator to begin watching for invalidations based on the newly specified set of items.

Parameters:

items - the items that will be watched for invalidations

Throws:

FdkException - if the operation fails.

reset

public void reset(long[] items)
           throws FdkException

Reset the ItemSetInvalidator to begin watching for invalidations based on the newly specified set of items.

Parameters:

items - the items that will be watched for invalidations

Throws:

FdkException - if the operation fails.

unregister

public void unregister()
                throws FdkException

Unregister the ItemSetInvalidator.

This should be called this when the Invalidator is no longer in use, to free up resources that would not otherwise be freed until the FdkSession is disconnected.

Throws:

FdkException - if the operation fails.