com.etherios.connector.core.events

Class RCIEvent

java.lang.Object

com.etherios.connector.core.events.Event

com.etherios.connector.core.events.RCIEvent

public class RCIEvent
extends Event

Basic RCI Event class containing common information and functionality for the different RCI event types.

See Also:

EventsListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_DO_COMMAND RCI do command event.
static int	TYPE_QUERY_DESCRIPTOR RCI query descriptor event.
static int	TYPE_QUERY_SETTING RCI query setting event.
static int	TYPE_QUERY_STATE RCI query state event.
static int	TYPE_RCI_ANSWER RCI answer event.
static int	TYPE_RCI_ERROR RCI error event.
static int	TYPE_REBOOT RCI reboot event.
static int	TYPE_SET_FACTORY_DEFAULTS RCI set factory defaults event.
static int	TYPE_SET_SETTING RCI set setting event.
static int	TYPE_SET_STATE RCI set state event.

Fields inherited from class com.etherios.connector.core.events.Event

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, TAG_DEBUG, TAG_ERROR, TAG_INFO, TYPE_CONNECTION, TYPE_DATA_POINT, TYPE_DATA_PUSH, TYPE_DEVICE_REQUEST, TYPE_FILE_SYSTEM, TYPE_FIRMWARE, TYPE_RCI

Constructor Summary

Constructors

Constructor and Description
RCIEvent(int rciType) Class constructor.
RCIEvent(int rciType, java.lang.String data) Class constructor.
RCIEvent(int rciType, java.lang.String target, java.lang.String data) Class constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventLogString() Retrieves the event string to be logged.
java.lang.String	getEventTypeTag() Retrieves the event type tag to be logged.
int	getRCIEventType() Retrieves the RCI event type.
java.lang.String	toString()

Methods inherited from class com.etherios.connector.core.events.Event

getEventSeverity, getEventType, setSeverity

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_DO_COMMAND

public static final int TYPE_DO_COMMAND

RCI do command event.

See Also:

Constant Field Values

TYPE_QUERY_DESCRIPTOR

public static final int TYPE_QUERY_DESCRIPTOR

RCI query descriptor event.

See Also:

Constant Field Values

TYPE_QUERY_SETTING

public static final int TYPE_QUERY_SETTING

RCI query setting event.

See Also:

Constant Field Values

TYPE_QUERY_STATE

public static final int TYPE_QUERY_STATE

RCI query state event.

See Also:

Constant Field Values

TYPE_RCI_ANSWER

public static final int TYPE_RCI_ANSWER

RCI answer event.

See Also:

Constant Field Values

TYPE_RCI_ERROR

public static final int TYPE_RCI_ERROR

RCI error event.

See Also:

Constant Field Values

TYPE_REBOOT

public static final int TYPE_REBOOT

RCI reboot event.

See Also:

Constant Field Values

TYPE_SET_FACTORY_DEFAULTS

public static final int TYPE_SET_FACTORY_DEFAULTS

RCI set factory defaults event.

See Also:

Constant Field Values

TYPE_SET_SETTING

public static final int TYPE_SET_SETTING

RCI set setting event.

See Also:

Constant Field Values

TYPE_SET_STATE

public static final int TYPE_SET_STATE

RCI set state event.

See Also:

Constant Field Values

Constructor Detail

RCIEvent

public RCIEvent(int rciType)

Class constructor. Instances a new object of type RCIEvent with the given data.

Parameters:

rciType - RCI Event type.

See Also:

TYPE_DO_COMMAND, TYPE_QUERY_DESCRIPTOR, TYPE_QUERY_SETTING, TYPE_QUERY_STATE, TYPE_RCI_ANSWER, TYPE_RCI_ERROR, TYPE_REBOOT, TYPE_SET_FACTORY_DEFAULTS, TYPE_SET_SETTING, TYPE_SET_STATE

RCIEvent

public RCIEvent(int rciType,
                java.lang.String data)

Class constructor. Instances a new object of type RCIEvent with the given data.

Parameters:

rciType - RCI Event type.

data - RCI Event data.

See Also:

TYPE_DO_COMMAND, TYPE_QUERY_DESCRIPTOR, TYPE_QUERY_SETTING, TYPE_QUERY_STATE, TYPE_RCI_ANSWER, TYPE_RCI_ERROR, TYPE_REBOOT, TYPE_SET_FACTORY_DEFAULTS, TYPE_SET_SETTING, TYPE_SET_STATE

RCIEvent

public RCIEvent(int rciType,
                java.lang.String target,
                java.lang.String data)

Class constructor. Instances a new object of type RCIEvent with the given data.

Parameters:

rciType - RCI Event type.

target - RCI Do Command Event target.

data - RCI Event data.

See Also:

TYPE_DO_COMMAND, TYPE_QUERY_DESCRIPTOR, TYPE_QUERY_SETTING, TYPE_QUERY_STATE, TYPE_RCI_ANSWER, TYPE_RCI_ERROR, TYPE_REBOOT, TYPE_SET_FACTORY_DEFAULTS, TYPE_SET_SETTING, TYPE_SET_STATE

Method Detail

getEventLogString

public java.lang.String getEventLogString()

Description copied from class: Event

Retrieves the event string to be logged.

Specified by:

getEventLogString in class Event

Returns:

The event string to be logged.

getEventTypeTag

public java.lang.String getEventTypeTag()

Description copied from class: Event

Retrieves the event type tag to be logged.

Specified by:

getEventTypeTag in class Event

Returns:

The event type tag to be logged.

getRCIEventType

public int getRCIEventType()

Retrieves the RCI event type.

Returns:

RCI event type.

See Also:

TYPE_DO_COMMAND, TYPE_QUERY_DESCRIPTOR, TYPE_QUERY_SETTING, TYPE_QUERY_STATE, TYPE_RCI_ANSWER, TYPE_RCI_ERROR, TYPE_REBOOT, TYPE_SET_FACTORY_DEFAULTS, TYPE_SET_SETTING, TYPE_SET_STATE

toString

public java.lang.String toString()

Overrides:

toString in class Event