org.electrocodeogram.cpc.core.api.provider.store
Interface IStoreProviderWriteLockHook


public interface IStoreProviderWriteLockHook

A special interface for exclusive write lock hook callbacks registered via the IStoreProvider.setWriteLockHook(IStoreProviderWriteLockHook) method.

There should be no reason why any plugin besides the CPC Track module should implement this interface.

Author:
vw
See Also:
IStoreProvider

Method Summary
 void aboutToGrantWriteLock()
          The callback method which will be called once any party tries to acquire an exclusive write lock on the IStoreProvider.
 

Method Detail

aboutToGrantWriteLock

void aboutToGrantWriteLock()
                           throws StoreLockingException
The callback method which will be called once any party tries to acquire an exclusive write lock on the IStoreProvider. Once this method is called the write lock will already have been granted, but the control will not yet have been transfered back to the requester of the lock.
An implementation should use a callback to this method as a chance to write back any internally cached, potentially dirty data to the IStoreProvider.

Throws:
StoreLockingException
See Also:
IStoreProvider.setWriteLockHook(IStoreProviderWriteLockHook)