org.rapla.facade
Interface UpdateModule

All Known Subinterfaces:

ClientFacade

public interface UpdateModule

Field Summary

static String

REFRESH_INTERVAL_ENTRY

Method Summary

void	addAllocationChangedListener(AllocationChangeListener triggerListener)
void	addModificationListener(ModificationListener listener) registers a new ModificationListener.
void	addUpdateErrorListener(UpdateErrorListener listener)
boolean	isClientForServer() returns if the Facade is connected through a server (false if it has a local store)
void	refresh() Refreshes the data that is in the cache (or on the client) and notifies all registered ModificationListeners with an update-event.
void	removeAllocationChangedListener(AllocationChangeListener triggerListener)
void	removeModificationListener(ModificationListener listener)
void	removeUpdateErrorListener(UpdateErrorListener listener)

Field Detail

REFRESH_INTERVAL_ENTRY

static final String REFRESH_INTERVAL_ENTRY

See Also:

Constant Field Values

Method Detail

refresh

void refresh()
             throws RaplaException

Refreshes the data that is in the cache (or on the client) and notifies all registered ModificationListeners with an update-event. There are two types of refreshs.

• Incremental Refresh: Only the changes are propagated
• Full Refresh: The complete data is reread. (Currently disabled in Rapla)

Incremental refreshs are the normal case if you have a client server basis. (In a single user system no refreshs are necessary at all). The refreshs are triggered in defined intervals if you use the webbased communication and automaticaly if you use the old communication layer. You can change the refresh interval via the admin options.

Of course you can call a refresh anytime you want to synchronize with the server, e.g. if you want to ensure you are uptodate before editing. If you are on the server you dont need to refresh.

WARNING: When using full refresh on a local file storage all information will be changed. So use it only if you modify the data from external. You better re-get and re-draw all the information in the Frontend after a full refresh.

Throws:

RaplaException

isClientForServer

boolean isClientForServer()

returns if the Facade is connected through a server (false if it has a local store)

addModificationListener

void addModificationListener(ModificationListener listener)

registers a new ModificationListener. A ModifictionEvent will be fired to every registered DateChangeListener when one or more entities have been added, removed or changed

See Also:

ModificationListener, ModificationEvent

removeModificationListener

void removeModificationListener(ModificationListener listener)

addUpdateErrorListener

void addUpdateErrorListener(UpdateErrorListener listener)

removeUpdateErrorListener

void removeUpdateErrorListener(UpdateErrorListener listener)

addAllocationChangedListener

void addAllocationChangedListener(AllocationChangeListener triggerListener)

removeAllocationChangedListener

void removeAllocationChangedListener(AllocationChangeListener triggerListener)