org.universAAL.hw.exporter.zigbee.ha.devices
Class ExporterActuatorCallee

java.lang.Object
  org.universAAL.middleware.bus.member.BusMember
      org.universAAL.middleware.bus.member.Callee
          org.universAAL.middleware.service.ServiceCallee
              org.universAAL.hw.exporter.zigbee.ha.devices.ExporterActuatorCallee

Direct Known Subclasses:

OnOffLightCallee

public abstract class ExporterActuatorCallee
extends ServiceCallee

Field Summary

static String	IN_DEVICE Argument suffix.
protected static String	NAMESPACE
protected ServiceProfile[]	newProfiles
static String	OUT_GET_ON_OFF Argument suffix.
static String	SERVICE_GET_ON_OFF Service suffix.
static String	SERVICE_TURN_OFF Service suffix.
static String	SERVICE_TURN_ON Service suffix.

Fields inherited from class org.universAAL.middleware.bus.member.BusMember

busResourceURI, owner, theBus

Constructor Summary

protected

ExporterActuatorCallee(ModuleContext context, ServiceProfile[] realizedServices)

Method Summary

void	communicationChannelBroken() This abstract method is called for each member of the bus when the bus is being stopped.
abstract Boolean	executeGet() When a GET STATUS service request is received, this method is called automatically.
abstract boolean	executeOff() When a SET OFF service request is received, this method is called automatically.
abstract boolean	executeOn() When a SET ON service request is received, this method is called automatically.
static ServiceProfile[]	getServiceProfiles(String namespace, String ontologyURI, Actuator actuator)
ServiceResponse	handleCall(ServiceCall call) The actual service method of the ServiceCallee.
void	unregister()

Methods inherited from class org.universAAL.middleware.service.ServiceCallee

addNewServiceProfiles, busDyingOut, getMyID, handleRequest, removeMatchingProfiles

Methods inherited from class org.universAAL.middleware.bus.member.BusMember

close, getType, getURI

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_GET_ON_OFF

public static final String SERVICE_GET_ON_OFF

Service suffix.

See Also:

Constant Field Values

OUT_GET_ON_OFF

public static final String OUT_GET_ON_OFF

Argument suffix.

See Also:

Constant Field Values

SERVICE_TURN_OFF

public static final String SERVICE_TURN_OFF

Service suffix.

See Also:

Constant Field Values

SERVICE_TURN_ON

public static final String SERVICE_TURN_ON

Service suffix.

See Also:

Constant Field Values

IN_DEVICE

public static final String IN_DEVICE

Argument suffix.

See Also:

Constant Field Values

NAMESPACE

protected static String NAMESPACE

newProfiles

protected ServiceProfile[] newProfiles

Constructor Detail

ExporterActuatorCallee

protected ExporterActuatorCallee(ModuleContext context,
                                 ServiceProfile[] realizedServices)

Method Detail

unregister

public void unregister()

communicationChannelBroken

public void communicationChannelBroken()

Description copied from class: ServiceCallee

This abstract method is called for each member of the bus when the bus is being stopped.

Specified by:

communicationChannelBroken in class ServiceCallee

handleCall

public ServiceResponse handleCall(ServiceCall call)

Description copied from class: ServiceCallee

The actual service method of the ServiceCallee. It is called by the bus whenever there is a call that need to be serviced by this ServiceCallee.

Specified by:

handleCall in class ServiceCallee

Parameters:

call - the call that needs to be serviced.

Returns:

the result of the call execution.

executeOn

public abstract boolean executeOn()

When a SET ON service request is received, this method is called automatically.

Returns:

true if the actuator could be set to ON

executeOff

public abstract boolean executeOff()

When a SET OFF service request is received, this method is called automatically.

Returns:

true if the actuator could be set to OFF

executeGet

public abstract Boolean executeGet()

When a GET STATUS service request is received, this method is called automatically.

Returns:

The Boolean value representing the status property of the actuator.

getServiceProfiles

public static ServiceProfile[] getServiceProfiles(String namespace,
                                                  String ontologyURI,
                                                  Actuator actuator)