com.sun.data.provider
Interface RefreshableDataProvider

All Superinterfaces:

DataProvider

All Known Implementing Classes:

CachedRowSetDataProvider, MethodResultDataProvider, MethodResultTableDataProvider

public interface RefreshableDataProvider

extends DataProvider

Behavioral interface that is implemented by DataProvider classes that offer refresh support. Calling the refresh() method on this interface causes the DataProvider to re-fetch whatever data it is representing from the underlying source. This may be a JDBC call, or an EJB or web service method invokation, etc. Any cached changes in the DataProvider will be lost.

Author:

Joe Nuxoll

Method Summary

void	addRefreshableDataListener(RefreshableDataListener listener) Register a new RefreshableDataListener to this RefreshableDataProvider instance.
RefreshableDataListener[]	getRefreshableDataListeners()
void	refresh() Cause a re-fetch of whatever data this DataProvider is representing from the underlying source.
void	removeRefreshableDataListener(RefreshableDataListener listener) Deregister an existing RefreshableDataListener from RefreshableDataProvider instance.

Methods inherited from interface com.sun.data.provider.DataProvider

addDataListener, getDataListeners, getFieldKey, getFieldKeys, getType, getValue, isReadOnly, removeDataListener, setValue

Method Detail

refresh

public void refresh()
             throws DataProviderException

Cause a re-fetch of whatever data this DataProvider is representing from the underlying source. This may result in a JDBC call, or an EJB or web service method invokation, etc. Any cached changes in the DataProvider will be lost.

Throws:

DataProviderException - Implementations may wish to surface internal exceptions (nested in DataProviderException). Consult the documentation of the specific DataProvider implementation for details on what exceptions might be wrapped by a DPE.

addRefreshableDataListener

public void addRefreshableDataListener(RefreshableDataListener listener)

Register a new RefreshableDataListener to this RefreshableDataProvider instance.

Parameters:

listener - New RefreshableDataListener to register

removeRefreshableDataListener

public void removeRefreshableDataListener(RefreshableDataListener listener)

Deregister an existing RefreshableDataListener from RefreshableDataProvider instance.

Parameters:

listener - Old RefreshableDataListener to remove

getRefreshableDataListeners

public RefreshableDataListener[] getRefreshableDataListeners()

Returns:

An array of the RefreshableDataListeners currently registered on this RefreshableDataProvider. If there are no registered listeners, a zero-length array is returned.