com.sdm.quasar.client.core.common
Interface Disposable

All Known Subinterfaces:
BasicValuesPlugIn, BooleanState, BooleanStateAdapter, ConfigurationDescriptor, CUFValueModelPlugIn, DataManagerPlugIn, DialogManager, IndexedValuesPlugIn, LifeCycle, Session, State, ValueChangedPlugIn
All Known Implementing Classes:
AbstractBooleanState, AbstractBooleanStateAdapter, AbstractCommandAdapter, AbstractConfigurationDescriptor, AbstractDataManagerPlugIn, AbstractPerChildService, AbstractServiceManager, AbstractSessionManager, AbstractState, ActionEnabledBooleanState, ButtonModelSelectedBooleanState, DefaultBasicValuesPlugIn, DefaultCUFValueModelPlugIn, DefaultDataCore, DefaultDataManagerComponent, DefaultDialogManager, DefaultFeatureManager, DefaultHierarchyManager, DefaultIndexedValuesPlugIn, DefaultSessionAdapter, DefaultSubDialogLifeCycleController, DefaultValueChangedPlugIn, DocumentTextAcceptedBooleanState, JComponentEnabledBooleanState, ListModelSelectedBooleanState, MutableState, NOTBooleanState, ThresholdCounterBooleanState, TreeModelSelectedBooleanState, ValueAcceptedBooleanState, ValueConfigurationDescriptor, WrapperBooleanState

public interface Disposable

Identifies a component that can be disposed.

This is usually an interface used by an administrating component. The usage interfaces of the components should not extend this interface, but the administration interface may do so.

Version:
1.0
Author:
Bernd Olleck, sd&m AG

Method Summary
 void dispose()
          Disposes the component.
 

Method Detail

dispose

public void dispose()
             throws DisposeException
Disposes the component.

Important:
This method is called by an administrating component and must never be called directly.

The implementation should release any resources or objects allocated and any services registered. Furthermore, this method should be developed carefully to free a maximum of resources even when the system may have become unstable. In case of one or multiple errors, you should collect them in a DisposeException, continue with the execution, and throw it at the end of the method.

Note: The implementation must not return before the component is disposed. Any threads or asynchronous calls started must be completed before this method returns.

Throws:
DisposeException - if there was one or more errors while disposing the component.