net.sf.mmm.client.ui.api.busy

Interface BusyManager

All Known Implementing Classes:

AbstractBusyManager, BusyManagerImplGwt

@ComponentSpecification
public interface BusyManager

This is the interface for a component that manages the busy indication of a client application. If an asynchronous client is busy for a while this should be indicated to the user. This is what this component is all about.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
boolean	isBusy() This method determines if the application client is currently busy.
BusySession	start(String id) This method starts a BusySession that has to be terminated by BusySession.stop().

Method Detail

isBusy

boolean isBusy()

This method determines if the application client is currently busy. Busy means the client is waiting for a remote invocation service result or performing client-side longer lasting logic (sorting long lists, complex rendering, etc.). The logic what happens is abstracted by the interface. Typically the user gets visual feedback (e.g. an animated wait image or progress-bar) and can not interact with the client (e.g. press additional buttons).
If the client is NOT busy, it is considered as idle and the user can interact normally with the client.

Returns:

true if busy, false otherwise.

start

BusySession start(String id)

This method starts a BusySession that has to be terminated by BusySession.stop(). If the application client is idle (NOT busy), it will switch to busy. Otherwise this is considered as a nested BusySession. Only after the initial BusySession have been stopped, the application will switch from busy back to idle mode.

Parameters:

id - is an identifier for the source or the reason for the client being busy.

Returns:

the BusySession used to stop the session.