com.bosch.iot.dm.groovy.di

Interface Feature

public interface Feature

Feature representation.

Method Summary

Modifier and Type	Method and Description
java.util.List<DefinitionIdentifier>	definitionIds() All feature identifiers.
void	deleteDesiredProperties() Deletes feature desired properties.
void	deleteDesiredProperty(java.lang.String path) Deletes a desired property identified by path.
void	deleteProperties() Deletes feature properties.
void	deleteProperty(java.lang.String path) Deletes the specified property.
java.util.List<Property>	desiredProperties() Returns the desired properties of this feature.
java.lang.Object	desiredProperty(java.lang.String propertyPath) Returns the desired property identified by the propertyPath parameter.
java.lang.String	deviceId() Returns the Thing identifier this Feature belongs to.
void	exec(java.lang.String operationId, java.lang.Object args, AsyncResult result) Used to build asynchronous programming through Continuation Passing Style.
java.lang.String	id() Feature id.
void	message(java.lang.String subject, java.lang.String payload) Send opaque message.
java.util.List<Property>	properties() All feature properties.
java.lang.Object	property(java.lang.String propertyPath) Find a feature property with the given path if such exists or null otherwise.
void	request(java.lang.String subject, java.lang.String payload, AsyncResult result) Send opaque message with response
void	setDesiredProperties(java.util.List<Property<?>> desiredProperties) Sets desired properties to this feature.
void	setDesiredProperty(Property<?> desiredProperty) Sets given desired property to this feature.
<T> void	setDesiredProperty(java.lang.String id, T value) Sets a desired property with given id and value to this feature.
void	setProperties(java.util.List<Property<?>> properties) Sets feature properties.
void	setProperty(Property<?> property) Sets given property to this feature.
<T> void	setProperty(java.lang.String id, T value) Sets a property with given id and value to this feature.

Method Detail

id

java.lang.String id()

Feature id.

Returns:

the feature identifier.

deviceId

java.lang.String deviceId()

Returns the Thing identifier this Feature belongs to.

Returns:

Thing identifier

definitionIds

java.util.List<DefinitionIdentifier> definitionIds()

All feature identifiers.

Returns:

all feature definitions.

exec

void exec(java.lang.String operationId,
          java.lang.Object args,
          AsyncResult result)

Used to build asynchronous programming through Continuation Passing Style.

Parameters:

operationId -

args -

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}

message

void message(java.lang.String subject,
             java.lang.String payload)

Send opaque message. Fire and forget.

Parameters:

subject - message subject

payload - payload

request

void request(java.lang.String subject,
             java.lang.String payload,
             AsyncResult result)

Send opaque message with response

Parameters:

subject - message subject

payload - payload

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}

properties

java.util.List<Property> properties()

All feature properties.

Returns:

feature properties.

property

java.lang.Object property(java.lang.String propertyPath)

Find a feature property with the given path if such exists or null otherwise.

Parameters:

propertyPath - a property path

Returns:

the found attribute or null

setProperty

void setProperty(Property<?> property)

Sets given property to this feature.

Parameters:

property - the value of the Property to be set. Id and group of Property are mandatory. Id can be path to a nested value

setProperty

<T> void setProperty(java.lang.String id,
                     T value)

Sets a property with given id and value to this feature.

Parameters:

id - property id.

value - property value.

deleteProperty

void deleteProperty(java.lang.String path)

Deletes the specified property.

Parameters:

path - the path of the feature property to deleted

setProperties

void setProperties(java.util.List<Property<?>> properties)

Sets feature properties.

Parameters:

properties - properties to be set

deleteProperties

void deleteProperties()

Deletes feature properties.

desiredProperties

java.util.List<Property> desiredProperties()

Returns the desired properties of this feature.

desiredProperty

java.lang.Object desiredProperty(java.lang.String propertyPath)

Returns the desired property identified by the propertyPath parameter.

Parameters:

propertyPath - the desired property path

Returns:

Feature desired property with propertyPath identifier

setDesiredProperty

void setDesiredProperty(Property<?> desiredProperty)

Sets given desired property to this feature.

Parameters:

desiredProperty - the value of the Property to be set. Id and group of Property are mandatory. Id can be path to a nested value

setDesiredProperty

<T> void setDesiredProperty(java.lang.String id,
                            T value)

Sets a desired property with given id and value to this feature.

Parameters:

id - desired property id.

value - desired property value.

deleteDesiredProperty

void deleteDesiredProperty(java.lang.String path)

Deletes a desired property identified by path.

Parameters:

path - the path of the desired property to deleted

setDesiredProperties

void setDesiredProperties(java.util.List<Property<?>> desiredProperties)

Sets desired properties to this feature.

Parameters:

desiredProperties - desired properties to be set

deleteDesiredProperties

void deleteDesiredProperties()

Deletes feature desired properties.