org.openbase.bco.dal.remote.unit.location

Class LocationRemote

java.lang.Object

org.openbase.jul.extension.rsb.com.RSBRemoteService<M>

org.openbase.jul.extension.rsb.com.AbstractIdentifiableRemote<M>

org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<D,rst.domotic.unit.UnitConfigType.UnitConfig>

org.openbase.bco.dal.remote.unit.AbstractUnitRemote<rst.domotic.unit.location.LocationDataType.LocationData>

org.openbase.bco.dal.remote.unit.location.LocationRemote

All Implemented Interfaces:

BlindStateOperationServiceCollection, BrightnessStateOperationServiceCollection, ColorStateOperationServiceCollection, IlluminanceStateProviderServiceCollection, MotionStateProviderServiceCollection, PowerConsumptionStateProviderServiceCollection, PowerStateOperationServiceCollection, SmokeAlarmStateProviderServiceCollection, SmokeStateProviderServiceCollection, StandbyStateOperationServiceCollection, TamperStateProviderServiceCollection, TargetTemperatureStateOperationServiceCollection, TemperatureStateProviderServiceCollection, BlindStateOperationService, BrightnessStateOperationService, ColorStateOperationService, OperationService, PowerStateOperationService, StandbyStateOperationService, TargetTemperatureStateOperationService, BlindStateProviderService, BrightnessStateProviderService, ColorStateProviderService, IlluminanceStateProviderService, MotionStateProviderService, PowerConsumptionStateProviderService, PowerStateProviderService, PresenceStateProviderService, ProviderService, SmokeAlarmStateProviderService, SmokeStateProviderService, StandbyStateProviderService, TamperStateProviderService, TargetTemperatureStateProviderService, TemperatureStateProviderService, Service, ServiceProvider, BaseUnit<rst.domotic.unit.location.LocationDataType.LocationData>, Location, MultiUnitServiceFusion, Unit<rst.domotic.unit.location.LocationDataType.LocationData>, UnitRemote<rst.domotic.unit.location.LocationDataType.LocationData>, org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.location.LocationDataType.LocationData>, org.openbase.jul.extension.rst.iface.ScopeProvider, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Configurable<String,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Identifiable<String>, 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.ConfigProvider<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.provider.LabelProvider, org.openbase.jul.iface.provider.PingProvider, org.openbase.jul.iface.Shutdownable, org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>, org.openbase.jul.pattern.ConfigurableRemote<String,rst.domotic.unit.location.LocationDataType.LocationData,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.pattern.IdentifiableRemote<String,rst.domotic.unit.location.LocationDataType.LocationData>, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData>, org.openbase.jul.pattern.Remote<rst.domotic.unit.location.LocationDataType.LocationData>

public class LocationRemote
extends AbstractUnitRemote<rst.domotic.unit.location.LocationDataType.LocationData>
implements Location

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 inherited from class org.openbase.jul.extension.rsb.com.RSBRemoteService

CONNECTION_TIMEOUT, DATA_WAIT_TIMEOUT, logger, LOGGING_TIMEOUT, maintainer, METHOD_CALL_MAX_TIMEOUT, METHOD_CALL_START_TIMEOUT, METHOD_CALL_TIMEOUT_MULTIPLIER, PING_TEST_TIMEOUT, PING_TIMEOUT, REQUEST_TIMEOUT, scope

Fields inherited from interface org.openbase.jul.iface.provider.LabelProvider

TYPE_FIELD_LABEL

Fields inherited from interface org.openbase.jul.iface.Identifiable

TYPE_FIELD_ID

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

DEFAULT_NEUTRAL_WHITE, DEFAULT_NEUTRAL_WHITE_COLOR, NEUTRAL_WHITE_KEY

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

UPDATE_METHOD_PREFIX

Constructor Summary

Constructors

Constructor and Description
LocationRemote()

Method Summary

Modifier and Type	Method and Description
void	activate()
Future<rst.domotic.action.ActionFutureType.ActionFuture>	applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription)
rst.domotic.unit.UnitConfigType.UnitConfig	applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config)
void	deactivate()
Set<rst.domotic.service.ServiceDescriptionType.ServiceDescription>	getAvailableServiceDescriptions() Method returns a set of all currently available service descriptions of this unit instance.
Set<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType>	getAvailableServiceTypes() Method returns a set of all currently available service types of this unit instance.
List<LocationRemote>	getChildLocationList(boolean waitForData)
List<ConnectionRemote>	getConnectionList(boolean waitForData)
List<ConnectionRemote>	getDirectConnectionList(String locationID, boolean waitForData) Method collects all connections between this and the given location and returns those instances.
List<String>	getNeighborLocationIds() Deprecated. please use Registries.getLocationRegistry().getNeighborLocations(String locationId) instead.
List<LocationRemote>	getNeighborLocationList(boolean waitForData)
Map<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType,List<UnitRemote>>	getProvidedUnitMap() Deprecated. please use getUnitMap() instead.
ServiceRemote	getServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
rst.domotic.state.StandbyStateType.StandbyState	getStandbyState()
rst.domotic.unit.UnitTemplateType.UnitTemplate	getTemplate(boolean onlyAvailableServices) Method returns the unit template of this unit containing all provided service templates.
Map<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType,List<UnitRemote>>	getUnitMap() Returns a Map of all units which directly or recursively provided by this location..
Map<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType,List<UnitRemote>>	getUnitMap(boolean recursive) Returns a Map of all units which are directly or recursively provided by this location..
<UR extends UnitRemote<?>> Collection<UR>	getUnits(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType, boolean waitForData, Class<UR> unitRemoteClass) Method returns a list of all units filtered by the given unit type which are directly or recursively provided by this location.
<UR extends UnitRemote<?>> Collection<UR>	getUnits(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType, boolean waitForData, Class<UR> unitRemoteClass, boolean recursive) Method returns a list of all units filtered by the given unit type which are directly provided by this location.
boolean	hasDirectConnection(String locationID, rst.domotic.unit.connection.ConnectionConfigType.ConnectionConfig.ConnectionType connectionType, boolean waitForData) Method checks if an direct connection exists between this and the given location.
Future<rst.domotic.action.SnapshotType.Snapshot>	recordSnapshot(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
Future<Void>	restoreSnapshot(rst.domotic.action.SnapshotType.Snapshot snapshot)
Future<rst.domotic.action.ActionFutureType.ActionFuture>	setStandbyState(rst.domotic.state.StandbyStateType.StandbyState standbyState)
protected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder	updateActionDescription(rst.domotic.action.ActionDescriptionType.ActionDescription.Builder actionDescription)

Methods inherited from class org.openbase.bco.dal.remote.unit.AbstractUnitRemote

addDataObserver, addDataObserver, addServiceStateObserver, getLabel, getLocationConfig, getParentLocationConfig, getParentLocationRemote, getScope, getTransformation, getUnitRegistry, getUnitTemplate, getUnitType, init, init, init, init, initById, initByLabel, isEnabled, postInit, recordSnapshot, removeDataObserver, removeDataObserver, removeServiceStateObserver, setSessionManager, shutdown, updateActionDescription, updateActionDescription, waitForData, waitForData

Methods inherited from class org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote

addConfigObserver, getConfig, getConfigClass, getConfigField, getConfigField, getId, hasConfigField, init, notifyConfigUpdate, removeConfigObserver, supportsConfigField

Methods inherited from class org.openbase.jul.extension.rsb.com.RSBRemoteService

activate, activate, addConnectionStateObserver, addHandler, addObserver, applyExternalDataUpdate, callMethod, callMethod, callMethod, callMethod, callMethodAsync, callMethodAsync, deactivate, getConnectionState, getData, getDataClass, getDataField, getIntenalPriorizedDataObservable, getPing, hasDataField, init, init, isActive, isConnected, isDataAvailable, isLocked, lock, notifyDataUpdate, ping, reinit, reinit, reinit, reinit, removeConnectionStateObserver, removeObserver, requestData, reset, setMessageProcessor, toString, unlock, validateActivation, validateData, validateInitialization, validateMiddleware, verifyMaintainability, waitForConnectionState, waitForConnectionState, waitForMiddleware

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.unit.location.Location

getPresenceState, getSupportedServiceTypes

Methods inherited from interface org.openbase.bco.dal.lib.layer.unit.Unit

addDataObserver, addServiceStateObserver, addServiceStateObserver, getGlobalBoundingBoxCenterPoint3d, getGlobalPosition, getGlobalPositionPoint3d, getGlobalRotation, getGlobalRotationQuat4d, getLocalBoundingBoxCenterPoint3d, getLocalPosition, getLocalRotation, getLocationRegistry, getRootToUnitTransform3D, getRootToUnitTransformation, getRootToUnitTransformationFuture, getTemplate, getTransactionIdByServiceType, getTransform3D, getTransform3DInverse, getType, getUnitBoundingBoxCenterGlobalPoint3d, getUnitBoundingBoxCenterPoint3d, getUnitPosition, getUnitPositionGlobal, getUnitPositionGlobalPoint3d, getUnitRotation, getUnitRotationGlobal, getUnitRotationGlobalQuat4d, getUnitShape, getUnitTemplate, getUnitToRootTransform3D, getUnitToRootTransformation, getUnitToRootTransformationFuture, getUnitType, recordSnapshot, removeDataObserver, removeServiceStateObserver, removeServiceStateObserver, verifyOperationServiceState, verifyOperationServiceStateValue

Methods inherited from interface org.openbase.jul.iface.provider.LabelProvider

getLabel

Methods inherited from interface org.openbase.jul.extension.rst.iface.ScopeProvider

getScope

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

getId

Methods inherited from interface org.openbase.jul.iface.provider.ConfigProvider

getConfig

Methods inherited from interface org.openbase.jul.pattern.provider.DataProvider

addDataObserver, getData, getDataClass, getDataFuture, isDataAvailable, removeDataObserver, waitForData, waitForData

Methods inherited from interface org.openbase.bco.dal.lib.layer.unit.MultiUnitServiceFusion

getBlindState, getBlindState, getBrightnessState, getBrightnessState, getColorState, getColorState, getIlluminanceState, getIlluminanceState, getMotionState, getMotionState, getPowerConsumptionState, getPowerConsumptionState, getPowerState, getPowerState, getSmokeAlarmState, getSmokeAlarmState, getSmokeState, getSmokeState, getStandbyState, getTamperState, getTamperState, getTargetTemperatureState, getTargetTemperatureState, getTemperatureState, getTemperatureState, setBlindState, setBlindState, setBrightnessState, setBrightnessState, setColorState, setColorState, setNeutralWhite, setPowerState, setPowerState, setPowerState, setPowerState, setStandbyState, setTargetTemperatureState, setTargetTemperatureState

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

verifyBrightnessState

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

setColor, setColor, setColor, setColor

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

getColor, getHSBColor, getJavaAWTColor, getRGBColor, verifyColor, verifyColorState, verifyHsbColor, verifyRgbColor

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

verifyBlindState

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

setStandbyState

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.TargetTemperatureStateProviderService

verifTargetTemperatureState

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.provider.TemperatureStateProviderService

verifyTemperatureState

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

addConfigObserver, getConfig, getConfigClass, removeConfigObserver

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

activate, activate, addConnectionStateObserver, getConnectionState, getPing, isConnected, ping, removeConnectionStateObserver, requestData

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

registerShutdownHook, registerShutdownHook

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

isActive

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

isLocked, lock, unlock, verifyMaintainability

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

init

Constructor Detail

LocationRemote

public LocationRemote()

Method Detail

applyConfigUpdate

public rst.domotic.unit.UnitConfigType.UnitConfig applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config)
                                                             throws org.openbase.jul.exception.CouldNotPerformException,
                                                                    InterruptedException

Description copied from class: AbstractUnitRemote

Specified by:

applyConfigUpdate in interface org.openbase.jul.iface.Configurable<String,rst.domotic.unit.UnitConfigType.UnitConfig>

Overrides:

applyConfigUpdate in class AbstractUnitRemote<rst.domotic.unit.location.LocationDataType.LocationData>

Parameters:

config -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

activate

public void activate()
              throws InterruptedException,
                     org.openbase.jul.exception.CouldNotPerformException

Description copied from class: AbstractUnitRemote

Specified by:

activate in interface org.openbase.jul.iface.Activatable

Overrides:

activate in class AbstractUnitRemote<rst.domotic.unit.location.LocationDataType.LocationData>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

deactivate

public void deactivate()
                throws InterruptedException,
                       org.openbase.jul.exception.CouldNotPerformException

Specified by:

deactivate in interface org.openbase.jul.iface.Activatable

Overrides:

deactivate in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.location.LocationDataType.LocationData>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

recordSnapshot

public Future<rst.domotic.action.SnapshotType.Snapshot> recordSnapshot(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                                throws org.openbase.jul.exception.CouldNotPerformException,
                                                                       InterruptedException

Specified by:

recordSnapshot in interface Location

Specified by:

recordSnapshot in interface MultiUnitServiceFusion

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

restoreSnapshot

public Future<Void> restoreSnapshot(rst.domotic.action.SnapshotType.Snapshot snapshot)
                             throws org.openbase.jul.exception.CouldNotPerformException,
                                    InterruptedException

Specified by:

restoreSnapshot in interface Unit<rst.domotic.unit.location.LocationDataType.LocationData>

Specified by:

restoreSnapshot in interface org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

applyAction

public Future<rst.domotic.action.ActionFutureType.ActionFuture> applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription)
                                                                     throws org.openbase.jul.exception.CouldNotPerformException,
                                                                            InterruptedException

Description copied from class: AbstractUnitRemote

Specified by:

applyAction in interface ServiceProvider

Overrides:

applyAction in class AbstractUnitRemote<rst.domotic.unit.location.LocationDataType.LocationData>

Parameters:

actionDescription -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

updateActionDescription

protected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder updateActionDescription(rst.domotic.action.ActionDescriptionType.ActionDescription.Builder actionDescription)
                                                                                              throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getServiceRemote

public ServiceRemote getServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
                               throws org.openbase.jul.exception.NotAvailableException

Specified by:

getServiceRemote in interface MultiUnitServiceFusion

Throws:

org.openbase.jul.exception.NotAvailableException

getNeighborLocationIds

@Deprecated
public List<String> getNeighborLocationIds()
                                                throws org.openbase.jul.exception.CouldNotPerformException

Deprecated. please use Registries.getLocationRegistry().getNeighborLocations(String locationId) instead.

Specified by:

getNeighborLocationIds in interface Location

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

getNeighborLocationList

public List<LocationRemote> getNeighborLocationList(boolean waitForData)
                                             throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getChildLocationList

public List<LocationRemote> getChildLocationList(boolean waitForData)
                                          throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getConnectionList

public List<ConnectionRemote> getConnectionList(boolean waitForData)
                                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getDirectConnectionList

public List<ConnectionRemote> getDirectConnectionList(String locationID,
                                                      boolean waitForData)
                                               throws org.openbase.jul.exception.CouldNotPerformException

Method collects all connections between this and the given location and returns those instances.

Parameters:

locationID - the location id of the location to check.

waitForData - flag defines if the method should block until all needed instances are available.

Returns:

a collection of unit connection remotes.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if the check could not be performed e.g. if some data is not available yet.

hasDirectConnection

public boolean hasDirectConnection(String locationID,
                                   rst.domotic.unit.connection.ConnectionConfigType.ConnectionConfig.ConnectionType connectionType,
                                   boolean waitForData)
                            throws org.openbase.jul.exception.CouldNotPerformException

Method checks if an direct connection exists between this and the given location.

Parameters:

locationID - the location id of the location to check.

connectionType - the type of the connection. To disable this filter use ConnectionType.UNKNOWN

waitForData - flag defines if the method should block until all needed instances are available.

Returns:

true if the specified connection exists.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if the check could not be performed e.g. if some data is not available yet.

getProvidedUnitMap

@Deprecated
public Map<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType,List<UnitRemote>> getProvidedUnitMap()
                                                                                                             throws org.openbase.jul.exception.NotAvailableException,
                                                                                                                    InterruptedException

Deprecated. please use getUnitMap() instead.

Returns:

Throws:

org.openbase.jul.exception.NotAvailableException

InterruptedException

getUnitMap

public Map<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType,List<UnitRemote>> getUnitMap()
                                                                                         throws org.openbase.jul.exception.NotAvailableException,
                                                                                                InterruptedException

Returns a Map of all units which directly or recursively provided by this location..

Returns:

the Map of provided units sorted by their UnitType.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the map is not available.

InterruptedException - is thrown if the current thread was externally interrupted.

getUnitMap

public Map<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType,List<UnitRemote>> getUnitMap(boolean recursive)
                                                                                         throws org.openbase.jul.exception.NotAvailableException,
                                                                                                InterruptedException

Returns a Map of all units which are directly or recursively provided by this location..

Parameters:

recursive - defines if recursive related unit should be included as well.

Returns:

the Map of provided units sorted by their UnitType.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the map is not available.

InterruptedException - is thrown if the current thread was externally interrupted.

getUnits

public <UR extends UnitRemote<?>> Collection<UR> getUnits(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType,
                                                          boolean waitForData,
                                                          Class<UR> unitRemoteClass)
                                                   throws org.openbase.jul.exception.CouldNotPerformException,
                                                          InterruptedException

Method returns a list of all units filtered by the given unit type which are directly or recursively provided by this location.

Type Parameters:

UR - the unit remote class type.

Parameters:

unitType - the unit type.

waitForData - if this flag is set to true the current thread will block until all unit remotes are fully synchronized with the unit controllers.

unitRemoteClass - the unit remote class.

Returns:

a map of instance of the given remote class.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case something went wrong.

InterruptedException - is thrown if the current thread was externally interrupted.

getUnits

public <UR extends UnitRemote<?>> Collection<UR> getUnits(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType,
                                                          boolean waitForData,
                                                          Class<UR> unitRemoteClass,
                                                          boolean recursive)
                                                   throws org.openbase.jul.exception.CouldNotPerformException,
                                                          InterruptedException

Method returns a list of all units filtered by the given unit type which are directly provided by this location. In case the recursive flag is set to true than recursive related units are included as well.

Type Parameters:

UR - the unit remote class type.

Parameters:

unitType - the unit type.

waitForData - if this flag is set to true the current thread will block until all unit remotes are fully synchronized with the unit controllers.

unitRemoteClass - the unit remote class.

recursive - defines if recursive related unit should be included as well.

Returns:

a map of instance of the given remote class.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case something went wrong.

InterruptedException - is thrown if the current thread was externally interrupted.

getTemplate

public rst.domotic.unit.UnitTemplateType.UnitTemplate getTemplate(boolean onlyAvailableServices)
                                                           throws org.openbase.jul.exception.NotAvailableException

Method returns the unit template of this unit containing all provided service templates.

Parameters:

onlyAvailableServices - if the filter flag is set to true, only service templates are included which are available for the current instance.

Returns:

the UnitTemplate of this unit.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the UnitTemplate is currently not available.

getAvailableServiceTypes

public Set<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> getAvailableServiceTypes()
                                                                                                  throws org.openbase.jul.exception.NotAvailableException

Method returns a set of all currently available service types of this unit instance.

Returns:

a set of ServiceTypes.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the service types can not be detected.

getAvailableServiceDescriptions

public Set<rst.domotic.service.ServiceDescriptionType.ServiceDescription> getAvailableServiceDescriptions()
                                                                                                   throws org.openbase.jul.exception.NotAvailableException

Method returns a set of all currently available service descriptions of this unit instance.

Returns:

a set of ServiceDescription.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the service types can not be detected.

setStandbyState

public Future<rst.domotic.action.ActionFutureType.ActionFuture> setStandbyState(rst.domotic.state.StandbyStateType.StandbyState standbyState)
                                                                         throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

setStandbyState in interface StandbyStateOperationService

Specified by:

setStandbyState in interface MultiUnitServiceFusion

Throws:

org.openbase.jul.exception.CouldNotPerformException

getStandbyState

public rst.domotic.state.StandbyStateType.StandbyState getStandbyState()
                                                                throws org.openbase.jul.exception.NotAvailableException

Specified by:

getStandbyState in interface StandbyStateOperationServiceCollection

Specified by:

getStandbyState in interface StandbyStateProviderService

Specified by:

getStandbyState in interface MultiUnitServiceFusion

Throws:

org.openbase.jul.exception.NotAvailableException