Module org.refcodes.component

Package org.refcodes.component

Interface LifecycleStatusHandle<H>

Type Parameters:

H - the generic type

All Known Subinterfaces:

ComponentHandleComposite<H,REF>, ConfigurableLifecycleComponentHandle.ConfigurableLifecycleAutomatonHandle<H,CTX>, LifecycleComponentHandle.LifecycleAutomatonHandle<H>

public interface LifecycleStatusHandle<H>

The Interface LifecycleStatusHandle.

Method Summary

Modifier and Type	Method	Description
LifecycleStatus	getLifecycleStatus(H aHandle)	Retrieves the LifecycleStatus related to the given handle.
boolean	hasLifecycleStatus(H aHandle)	Determines whether the handle reference provides a LifecycleStatus by implementing the LifecycleStatusAccessor interface.

Method Details

hasLifecycleStatus

boolean hasLifecycleStatus(H aHandle)
                    throws UnknownHandleRuntimeException

Determines whether the handle reference provides a LifecycleStatus by implementing the LifecycleStatusAccessor interface.

Parameters:

aHandle - The handle to test whether the reference provides the according functionality.

Returns:

True in case the reference provides the according functionality.

Throws:

UnknownHandleRuntimeException - in case the handle is unknown.

getLifecycleStatus

LifecycleStatus getLifecycleStatus(H aHandle)
                            throws UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException

Retrieves the LifecycleStatus related to the given handle. Determines in which LifecycleStatus status a component related to the given handle is in.

Parameters:

aHandle - The handle for which to retrieve the LifecycleStatus.

Returns:

Returns the LifecycleStatus related to the given handle.

Throws:

UnknownHandleRuntimeException - in case the given handle is unknown.

UnsupportedHandleOperationRuntimeException - in case the reference of the handle does not support the requested operation.