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

Interface BusySession

All Superinterfaces:

AttributeReadId<String>, Stoppable

All Known Implementing Classes:

AbstractBusyManager.BusySessionImpl

public interface BusySession
extends AttributeReadId<String>, Stoppable

This is the interface for a busy session. It represents a session during which the application client is busy. After the logic making the client busy is performed this BusySession has to be stopped.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
String	getId() This method gets the ID used to identify this object.
boolean	isStopped()
void	stop() This method stops this busy session.

Method Detail

getId

String getId()

This method gets the ID used to identify this object. An ID should be unique.

Specified by:

getId in interface AttributeReadId<String>

Returns:

the object's ID.

See Also:

BusyManager.start(String)

stop

void stop()

This method stops this busy session. It should be called exactly once. Additional invocations of this method on the same BusySession may log a warning but have no further effect. If the top-level BusySession is stopped, the application client changes from busy back to idle.

Specified by:

stop in interface Stoppable

isStopped

boolean isStopped()

Returns:

true if this BusySession has already been stopped.