com.sitewhere.spi.device.request

Interface IDeviceCreateRequest

All Known Implementing Classes:

DeviceCreateRequest

public interface IDeviceCreateRequest

Interface for arguments needed to create a device.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComments() Get comments associated with device.
java.util.List<IDeviceElementMapping>	getDeviceElementMappings() Get the list of device element mappings.
java.lang.String	getHardwareId() Get the unique device hardware id.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get metadata values.
java.lang.String	getParentHardwareId() Get the parent hardware id (if nested).
java.lang.String	getSiteToken() Get the site token.
java.lang.String	getSpecificationToken() Get the device specification token.
DeviceStatus	getStatus() Get device status indicator.
java.lang.Boolean	isRemoveParentHardwareId() Indicates whether parent reference should be removed.

Method Detail

getHardwareId

java.lang.String getHardwareId()

Get the unique device hardware id.

Returns:

getSiteToken

java.lang.String getSiteToken()

Get the site token.

Returns:

getSpecificationToken

java.lang.String getSpecificationToken()

Get the device specification token.

Returns:

getParentHardwareId

java.lang.String getParentHardwareId()

Get the parent hardware id (if nested).

Returns:

isRemoveParentHardwareId

java.lang.Boolean isRemoveParentHardwareId()

Indicates whether parent reference should be removed.

Returns:

getDeviceElementMappings

java.util.List<IDeviceElementMapping> getDeviceElementMappings()

Get the list of device element mappings.

Returns:

getComments

java.lang.String getComments()

Get comments associated with device.

Returns:

getStatus

DeviceStatus getStatus()

Get device status indicator.

Returns:

getMetadata

java.util.Map<java.lang.String,java.lang.String> getMetadata()

Get metadata values.

Returns: