com.ibm.sensorevent.model
Interface IPayload

All Superinterfaces:
IGenericGroup, IGroup
All Known Subinterfaces:
ISensorEventPayload
All Known Implementing Classes:
AlertDebugPayload, AlertErrorPayload, AlertInfoPayload, AlertWarningPayload, ApplicationPingPayload, ApplicationPongPayload, CommandPayload, HeartbeatPayload, IBMSensorEventPayload, PassiveRFIDAggregatedTagReadPayload, PassiveRFIDTagReadPayload, Payload, PortalCommandPayload, PortalReportPayload, ReloadPayload, ReportPayload, RestartPayload, TagReadFeedbackPayload, TagReadReportPayload

public interface IPayload
extends IGroup

IPayload is the interface representing the class Payload.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void copyFields(IPayload sourcePayload)
          Copies the fields unique to this class (such as payload class name) from the source payload into this payload
 java.lang.String getPayloadClassName()
          Returns the payload's class name
 void setPayloadClassName(java.lang.String s)
          Sets the payload's class name
 
Methods inherited from interface com.ibm.sensorevent.model.IGroup
toMap, toTypedMap
 
Methods inherited from interface com.ibm.sensorevent.model.generic.IGenericGroup
addAttribute, addAttributeArray, addBooleanArrayAttribute, addBooleanAttribute, addByteArrayAttribute, addByteAttribute, addDateArrayAttribute, addDateArrayAttributeAsLong, addDateAttribute, addDateAttributeAsLong, addDoubleArrayAttribute, addDoubleAttribute, addFloatArrayAttribute, addFloatAttribute, addGroup, addHexAttribute, addHexAttribute, addIntArrayAttribute, addIntAttribute, addLongArrayAttribute, addLongAttribute, addShortArrayAttribute, addShortAttribute, addStringArrayAttribute, addStringAttribute, createGroupPath, getAttribute, getAttributes, getAttributesAsList, getBooleanAttributeArrayValue, getBooleanAttributeValue, getByteAttributeArrayValue, getByteAttributeValue, getDateAttributeArrayValue, getDateAttributeArrayValueAsLong, getDateAttributeValue, getDateAttributeValueAsLong, getDoubleAttributeArrayValue, getDoubleAttributeValue, getFloatAttributeArrayValue, getFloatAttributeValue, getGroup, getGroups, getGroupsAsList, getHexAttributeValue, getHexAttributeValueAsString, getIntAttributeArrayValue, getIntAttributeValue, getLongAttributeArrayValue, getLongAttributeValue, getName, getShortAttributeArrayValue, getShortAttributeValue, getStringAttributeArrayValue, getStringAttributeValue, removeAttributes, removeGroups, setAttributes, setGroups, setName, traverseGroupPath
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getPayloadClassName

java.lang.String getPayloadClassName()
                                     throws SensorEventException
Returns the payload's class name

Throws:
SensorEventException

setPayloadClassName

void setPayloadClassName(java.lang.String s)
                         throws SensorEventException
Sets the payload's class name

Throws:
SensorEventException

copyFields

void copyFields(IPayload sourcePayload)
                throws SensorEventException
Copies the fields unique to this class (such as payload class name) from the source payload into this payload

Parameters:
sourcePayload - the source payload
Throws:
SensorEventException


Copyright © 2005 - 2009 IBM Corp. All Rights Reserved.