org.openbase.bco.dal.remote.service

Class PowerStateServiceRemote

java.lang.Object

org.openbase.bco.dal.remote.service.AbstractServiceRemote<PowerStateOperationService,rst.domotic.state.PowerStateType.PowerState>

org.openbase.bco.dal.remote.service.PowerStateServiceRemote

All Implemented Interfaces:

PowerStateOperationServiceCollection, OperationService, PowerStateOperationService, PowerStateProviderService, ProviderService, Service, ServiceProvider, ServiceRemote<PowerStateOperationService,rst.domotic.state.PowerStateType.PowerState>, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Initializable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Lockable, org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.provider.PingProvider, org.openbase.jul.iface.Shutdownable, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PowerStateType.PowerState>, org.openbase.jul.pattern.Remote<rst.domotic.state.PowerStateType.PowerState>

public class PowerStateServiceRemote
extends AbstractServiceRemote<PowerStateOperationService,rst.domotic.state.PowerStateType.PowerState>
implements PowerStateOperationServiceCollection

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.pattern.Remote

org.openbase.jul.pattern.Remote.ConnectionState

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	INFRASTRUCTURE_UNITS_FILTERED
static boolean	INFRASTRUCTURE_UNITS_HANDELED
static String	META_CONFIG_UNIT_INFRASTRUCTURE_FLAG

Fields inherited from class org.openbase.bco.dal.remote.service.AbstractServiceRemote

logger, maintainer, serviceStateObservable

Fields inherited from interface org.openbase.bco.dal.lib.layer.service.provider.ProviderService

UPDATE_METHOD_PREFIX

Fields inherited from interface org.openbase.bco.dal.lib.layer.service.Service

RESPONSIBLE_ACTION_FIELD_NAME, SERVICE_LABEL, SERVICE_MODE_PACKAGE, SERVICE_STATE_PACKAGE

Constructor Summary

Constructors

Constructor and Description
PowerStateServiceRemote() Constructor creates a new service remote.
PowerStateServiceRemote(boolean filterInfrastructureUnits) Constructor creates a new service remote.

Method Summary

Modifier and Type	Method and Description
protected rst.domotic.state.PowerStateType.PowerState	computeServiceState() Compute the service state of this service collection if an underlying service changes.
rst.domotic.state.PowerStateType.PowerState	getPowerState()
rst.domotic.state.PowerStateType.PowerState	getPowerState(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
Collection<PowerStateOperationService>	getPowerStateOperationServices()
void	init(rst.domotic.unit.UnitConfigType.UnitConfig config)
void	setInfrastructureFilter(boolean enabled) Must be called before init.
Future<rst.domotic.action.ActionFutureType.ActionFuture>	setPowerState(rst.domotic.state.PowerStateType.PowerState powerState)
Future<rst.domotic.action.ActionFutureType.ActionFuture>	setPowerState(rst.domotic.state.PowerStateType.PowerState powerState, rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)

Methods inherited from class org.openbase.bco.dal.remote.service.AbstractServiceRemote

activate, activate, addDataObserver, addServiceStateObserver, applyAction, deactivate, getData, getDataClass, getInternalUnits, getInternalUnits, getPing, getServices, getServices, getServiceState, getServiceType, hasInternalRemotes, init, isActive, isConnected, isDataAvailable, isLocked, lock, ping, removeDataObserver, removeServiceStateObserver, removeUnit, requestData, shutdown, toString, unlock, verifyMaintainability, verifyServiceCompatibility, waitForData, waitForData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.collection.PowerStateOperationServiceCollection

setPowerState

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.operation.PowerStateOperationService

setPowerState

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.operation.OperationService

verifyValueRange

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.provider.ProviderService

getUpdateMethodName

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.Service

buildServiceState, detectServiceDataClass, detectServiceMethod, detectServiceMethod, getArgumentClasses, getServiceBaseName, getServicePrefix, getServiceStateClass, getServiceStateName, getServiceStateName, getServiceStateValues, getServiceType, invokeOperationServiceMethod, invokeProviderServiceMethod, invokeServiceMethod, invokeServiceMethod, upateActionDescription, upateActionDescription

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.ServiceRemote

activate, addConnectionStateObserver, getConnectionState, removeConnectionStateObserver, requestData

Methods inherited from interface org.openbase.jul.pattern.Remote

getDataFuture

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook

Field Detail

META_CONFIG_UNIT_INFRASTRUCTURE_FLAG

public static final String META_CONFIG_UNIT_INFRASTRUCTURE_FLAG

See Also:

Constant Field Values

INFRASTRUCTURE_UNITS_FILTERED

public static final boolean INFRASTRUCTURE_UNITS_FILTERED

See Also:

Constant Field Values

INFRASTRUCTURE_UNITS_HANDELED

public static final boolean INFRASTRUCTURE_UNITS_HANDELED

See Also:

Constant Field Values

Constructor Detail

PowerStateServiceRemote

public PowerStateServiceRemote()

Constructor creates a new service remote. Note: This remote instance totally ignores infrastructure units.

PowerStateServiceRemote

public PowerStateServiceRemote(boolean filterInfrastructureUnits)

Constructor creates a new service remote. Note: This remote instance totally ignores infrastructure units.

Parameters:

filterInfrastructureUnits - this flag defines if units which are marked as infrastructure are filtered by this instance.

Method Detail

init

public void init(rst.domotic.unit.UnitConfigType.UnitConfig config)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Description copied from class: AbstractServiceRemote

Specified by:

init in interface org.openbase.jul.iface.Initializable<rst.domotic.unit.UnitConfigType.UnitConfig>

Overrides:

init in class AbstractServiceRemote<PowerStateOperationService,rst.domotic.state.PowerStateType.PowerState>

Parameters:

config -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

getPowerStateOperationServices

public Collection<PowerStateOperationService> getPowerStateOperationServices()

setPowerState

public Future<rst.domotic.action.ActionFutureType.ActionFuture> setPowerState(rst.domotic.state.PowerStateType.PowerState powerState)
                                                                       throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

setPowerState in interface PowerStateOperationService

Throws:

org.openbase.jul.exception.CouldNotPerformException

setPowerState

public Future<rst.domotic.action.ActionFutureType.ActionFuture> setPowerState(rst.domotic.state.PowerStateType.PowerState powerState,
                                                                              rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                                       throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

setPowerState in interface PowerStateOperationServiceCollection

Throws:

org.openbase.jul.exception.CouldNotPerformException

computeServiceState

protected rst.domotic.state.PowerStateType.PowerState computeServiceState()
                                                                   throws org.openbase.jul.exception.CouldNotPerformException

Compute the service state of this service collection if an underlying service changes. Computes the power state as on if at least one underlying service is on and else off.

Specified by:

computeServiceState in class AbstractServiceRemote<PowerStateOperationService,rst.domotic.state.PowerStateType.PowerState>

Returns:

the computed server state is returned.

Throws:

org.openbase.jul.exception.CouldNotPerformException - if an underlying service throws an exception

getPowerState

public rst.domotic.state.PowerStateType.PowerState getPowerState()
                                                          throws org.openbase.jul.exception.NotAvailableException

Specified by:

getPowerState in interface PowerStateOperationServiceCollection

Specified by:

getPowerState in interface PowerStateProviderService

Throws:

org.openbase.jul.exception.NotAvailableException

getPowerState

public rst.domotic.state.PowerStateType.PowerState getPowerState(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                          throws org.openbase.jul.exception.NotAvailableException

Specified by:

getPowerState in interface PowerStateOperationServiceCollection

Throws:

org.openbase.jul.exception.NotAvailableException

setInfrastructureFilter

public void setInfrastructureFilter(boolean enabled)

Must be called before init.

Overrides:

setInfrastructureFilter in class AbstractServiceRemote<PowerStateOperationService,rst.domotic.state.PowerStateType.PowerState>

Parameters:

enabled -