com.TersoSolutions.Jetstream.SDK.Application.Events

Class CommandCompletionEvent

java.lang.Object

com.TersoSolutions.Jetstream.SDK.Application.Events.JetstreamEvent

com.TersoSolutions.Jetstream.SDK.Application.Events.CommandCompletionEvent

public class CommandCompletionEvent
extends JetstreamEvent

CommandCompletionEvent is published when a command has been completed on a device. The CommandCompletionEvent will include any output parameters, exceptions and device extensions for completing the command. This class is a read only alias class for the Jetstream CommandCompletionEvent object created by the JAXB class generator. This class is used to avoid class naming collisions with additional support for creating the object from xml strings and returning the original xml message.

Since:

1.2

Author:

Johnathon Ender

See Also:

JetstreamEvent

Constructor Summary

Constructors

Constructor and Description
CommandCompletionEvent(java.lang.String xml) Creates a new CommandCompletionEvent object from an xml string

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommandId() Get the 'CommandId' attribute value.
java.util.List<DeviceExtension>	getDeviceExtensionList() Get the list of 'DeviceExtension' element items.
java.lang.String	getEventId() Get the 'EventId' attribute value.
java.util.Date	getEventTime() Get the 'EventTime' attribute value.
java.util.List<CommandCompletionException>	getExceptionList() Get the list of 'Exception' element items.
java.util.List<OutputParameter>	getOutputParameterList() Get the list of 'OutputParameter' element items.
java.util.Date	getReceivedTime() Get the 'ReceivedTime' attribute value.

Methods inherited from class com.TersoSolutions.Jetstream.SDK.Application.Events.JetstreamEvent

getId, getSourceXML, getTime, getType, setId, setSource, setTime, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandCompletionEvent

public CommandCompletionEvent(java.lang.String xml)

Creates a new CommandCompletionEvent object from an xml string

Parameters:

xml - The xml string to be deserialized into an CommandCompletionEvent object

Method Detail

getEventId

public java.lang.String getEventId()

Get the 'EventId' attribute value. The unique identifier for the Event

Returns:

value

getEventTime

public java.util.Date getEventTime()

Get the 'EventTime' attribute value. The ISO 8601 compliant UTC date and time (yyyy-mm-ddThh:mm:ssZ) the event occurred

Returns:

value

getReceivedTime

public java.util.Date getReceivedTime()

Get the 'ReceivedTime' attribute value. The ISO 8601 compliant UTC date and time (yyyy-mm-ddThh:mm:ssZ) that Jetstream received the message from the device

Returns:

The ISO 8601 compliant UTC date and time

getOutputParameterList

public java.util.List<OutputParameter> getOutputParameterList()

Get the list of 'OutputParameter' element items. A list of OutputParameter generated by the execution of the command

Returns:

list

getExceptionList

public java.util.List<CommandCompletionException> getExceptionList()

Get the list of 'Exception' element items. A list of Exception that occurred when executing the command on the device

Returns:

list

getDeviceExtensionList

public java.util.List<DeviceExtension> getDeviceExtensionList()

Get the list of 'DeviceExtension' element items. List of device extensions applicable to the CommandCompletion Event

Returns:

list

getCommandId

public java.lang.String getCommandId()

Get the 'CommandId' attribute value. The Id of the command queued by Jetstream and executed by the device

Returns:

value