org.gvsig.andami.plugins.status

Interface IExtensionStatus

All Known Implementing Classes:

ProjectExtension

public interface IExtensionStatus

This interface provides a framework to query the status of extensions. By default, the interface provides methods to check if the extension has some unsaved data (and save them), and methods to check if the extension has some associated background tasks. However, additional aspects can be included in the status by extending this interface.

Each extension will have an associated IExtensionStatus object, which can be used at any time to check the status. This is specially useful during the Andami termination process, to check if there are unfinished tasks which should be attended before exiting.

See Also:

IUnsavedData, UnsavedData, IExtension

Method Summary

Modifier and Type	Method and Description
IMonitorableTask[]	getRunningProcesses() Gets an array of the traceable background tasks associated with this extension.
IUnsavedData[]	getUnsavedData() Gets an array of the UnsavedData objects, which contain information about the unsaved data and allows to save it.
boolean	hasRunningProcesses() This method is used to check if the extension has some associated background process which is currently running.
boolean	hasUnsavedData() This method is used to check if the extension has some unsaved data.

Method Detail

hasUnsavedData

boolean hasUnsavedData()

This method is used to check if the extension has some unsaved data. For example, if the project has been modified, or there is a layer in edition mode.

Returns:

true if the extension has some unsaved data, false otherwise.

getUnsavedData

IUnsavedData[] getUnsavedData()

Gets an array of the UnsavedData objects, which contain information about the unsaved data and allows to save it.

Returns:

An array of the associated unsaved data, or null in case the extension has not unsaved data.

hasRunningProcesses

boolean hasRunningProcesses()

This method is used to check if the extension has some associated background process which is currently running.

Returns:

true if the extension has some associated background process, false otherwise.

getRunningProcesses

IMonitorableTask[] getRunningProcesses()

Gets an array of the traceable background tasks associated with this extension. These tasks may be tracked, canceled, etc.

Returns:

An array of the associated background tasks, or null in case there is no associated background tasks.