Package org.openhab.core.config.core.status

Interface ConfigStatusProvider

All Known Implementing Classes:

ConfigStatusBridgeHandler, ConfigStatusThingHandler

@NonNullByDefault
public interface ConfigStatusProvider

The ConfigStatusProvider can be implemented and registered as an OSGi service to provide status information for Configurations of entities. The ConfigStatusService tracks each ConfigStatusProvider and provides the corresponding ConfigStatusInfo by the operation ConfigStatusService.getConfigStatus(String, Locale).

Author:

Thomas Höfer - Initial contribution

Method Summary

Modifier and Type	Method	Description
Collection<ConfigStatusMessage>	getConfigStatus()	Returns the configuration status in form of a collection of ConfigStatusMessages for the Configuration of the entity that is supported by this ConfigStatusProvider.
void	setConfigStatusCallback(@Nullable ConfigStatusCallback configStatusCallback)	Sets the given ConfigStatusCallback for the ConfigStatusProvider.
boolean	supportsEntity(String entityId)	Determines if the ConfigStatusProvider instance can provide the configuration status information for the given entity.

Method Details

getConfigStatus

Collection<ConfigStatusMessage> getConfigStatus()

Returns the configuration status in form of a collection of ConfigStatusMessages for the Configuration of the entity that is supported by this ConfigStatusProvider.

Returns:

the requested configuration status (not null)

supportsEntity

boolean supportsEntity(String entityId)

Determines if the ConfigStatusProvider instance can provide the configuration status information for the given entity.

Parameters:

entityId - the id of the entity whose configuration status information is to be provided

Returns:

true, if the ConfigStatusProvider instance supports the given entity, otherwise false

setConfigStatusCallback

void setConfigStatusCallback(@Nullable ConfigStatusCallback configStatusCallback)

Sets the given ConfigStatusCallback for the ConfigStatusProvider.

Parameters:

configStatusCallback - the configuration status callback to be set