com.sitewhere.rest.model.device.event

Class DeviceEvent

java.lang.Object

com.sitewhere.rest.model.common.MetadataProvider

com.sitewhere.rest.model.device.event.DeviceEvent

All Implemented Interfaces:

IMetadataProvider, IDeviceEvent, java.io.Serializable, java.lang.Comparable<IDeviceEvent>

Direct Known Subclasses:

DeviceAlert, DeviceCommandInvocation, DeviceCommandResponse, DeviceLocation, DeviceMeasurement, DeviceMeasurements, DeviceStateChange, DeviceStreamData

public abstract class DeviceEvent
extends MetadataProvider
implements IDeviceEvent, java.lang.Comparable<IDeviceEvent>, java.io.Serializable

Model object for an event originating from a remote device.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceEvent(DeviceEventType type)

Method Summary

Modifier and Type	Method and Description
int	compareTo(IDeviceEvent other)
static void	copy(IDeviceEvent source, DeviceEvent target) Create a copy of an SPI object.
java.lang.String	getAssetId() Get id of asset if associated.
java.lang.String	getAssetModuleId() Get id of asset module.
DeviceAssignmentType	getAssignmentType() Get assignment type.
java.lang.String	getDeviceAssignmentToken() Get the device assignment the event pertains to.
java.util.Date	getEventDate() Get the date the event occurred.
DeviceEventType	getEventType() Get event type indicator.
java.lang.String	getId() Get a string that uniquely identifies the event.
java.util.Date	getReceivedDate() Get the date this event was received.
java.lang.String	getSiteToken() Get token for site the event pertains to.
void	setAssetId(java.lang.String assetId)
void	setAssetModuleId(java.lang.String assetModuleId)
void	setAssignmentType(DeviceAssignmentType assignmentType)
void	setDeviceAssignmentToken(java.lang.String deviceAssignmentToken)
void	setEventDate(java.util.Date eventDate)
void	setEventType(DeviceEventType eventType)
void	setId(java.lang.String id)
void	setReceivedDate(java.util.Date receivedDate)
void	setSiteToken(java.lang.String siteToken)

Methods inherited from class com.sitewhere.rest.model.common.MetadataProvider

addOrReplaceMetadata, clearMetadata, copy, copy, getMetadata, getMetadata, removeMetadata, setMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sitewhere.spi.common.IMetadataProvider

addOrReplaceMetadata, clearMetadata, getMetadata, getMetadata, removeMetadata

Constructor Detail

DeviceEvent

public DeviceEvent(DeviceEventType type)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: IDeviceEvent

Get a string that uniquely identifies the event.

Specified by:

getId in interface IDeviceEvent

Returns:

setId

public void setId(java.lang.String id)

getEventType

public DeviceEventType getEventType()

Description copied from interface: IDeviceEvent

Get event type indicator.

Specified by:

getEventType in interface IDeviceEvent

Returns:

setEventType

public void setEventType(DeviceEventType eventType)

getSiteToken

public java.lang.String getSiteToken()

Description copied from interface: IDeviceEvent

Get token for site the event pertains to.

Specified by:

getSiteToken in interface IDeviceEvent

Returns:

setSiteToken

public void setSiteToken(java.lang.String siteToken)

getDeviceAssignmentToken

public java.lang.String getDeviceAssignmentToken()

Description copied from interface: IDeviceEvent

Get the device assignment the event pertains to.

Specified by:

getDeviceAssignmentToken in interface IDeviceEvent

Returns:

setDeviceAssignmentToken

public void setDeviceAssignmentToken(java.lang.String deviceAssignmentToken)

getAssignmentType

public DeviceAssignmentType getAssignmentType()

Description copied from interface: IDeviceEvent

Get assignment type.

Specified by:

getAssignmentType in interface IDeviceEvent

Returns:

setAssignmentType

public void setAssignmentType(DeviceAssignmentType assignmentType)

getAssetModuleId

public java.lang.String getAssetModuleId()

Description copied from interface: IDeviceEvent

Get id of asset module.

Specified by:

getAssetModuleId in interface IDeviceEvent

Returns:

setAssetModuleId

public void setAssetModuleId(java.lang.String assetModuleId)

getAssetId

public java.lang.String getAssetId()

Description copied from interface: IDeviceEvent

Get id of asset if associated.

Specified by:

getAssetId in interface IDeviceEvent

Returns:

setAssetId

public void setAssetId(java.lang.String assetId)

getEventDate

public java.util.Date getEventDate()

Description copied from interface: IDeviceEvent

Get the date the event occurred.

Specified by:

getEventDate in interface IDeviceEvent

Returns:

setEventDate

public void setEventDate(java.util.Date eventDate)

getReceivedDate

public java.util.Date getReceivedDate()

Description copied from interface: IDeviceEvent

Get the date this event was received.

Specified by:

getReceivedDate in interface IDeviceEvent

Returns:

setReceivedDate

public void setReceivedDate(java.util.Date receivedDate)

compareTo

public int compareTo(IDeviceEvent other)

Specified by:

compareTo in interface java.lang.Comparable<IDeviceEvent>

copy

public static void copy(IDeviceEvent source,
                        DeviceEvent target)
                 throws SiteWhereException

Create a copy of an SPI object. Used by web services for marshaling.

Parameters:

source -

target -

Throws:

SiteWhereException