com.ibm.sensorevent.model
Interface IHeader

All Superinterfaces:
IGenericGroup, IGroup
All Known Implementing Classes:
Header

public interface IHeader
extends IGroup

IHeader is the interface representing the class Header.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getAssetId()
          Returns the header's asset ID attribute value
 long getDateTime()
          Returns the header's date-time attribute value as a long millisecond value
 java.lang.String getDateTimeAsString()
          Returns the header's date-time attribute value as an ISO 8601 date string
 java.lang.String getEventId()
          Returns the header's event ID attribute value
 java.lang.String getEventType()
          Returns the header's event type attribute value
 java.lang.String getGeoLocation()
          Returns the header's geographical location attribute value
 java.lang.String getOriginatingEventId()
          Returns the header's originating event ID attribute value
 short getPriority()
          Returns the header's priority attribute value
 java.lang.String getSourceApplication()
          Returns the header's source application attribute value
 java.lang.String getSourceComponent()
          Returns the header's source component attribute value
 java.lang.String getSourceComponentIdType()
          Returns the header's source component ID type attribute value
 java.lang.String getSourceComponentType()
          Returns the header's source component type attribute value
 IGroup getSourceGroup()
          Returns the header's source component subgroup
 java.lang.String getSourceId()
          Returns the header's source ID attribute value
 java.lang.String getSourceLocation()
          Returns the header's source component location attribute value
 java.lang.String getSourceLocationType()
          Returns the header's source component location type attribute value
 java.lang.String getSourceSubComponent()
          Returns the header's source component subcomponent attribute value
 java.lang.String getTargetId()
          Returns the header's target ID attribute value
 void setAssetId(java.lang.String assetId)
          Sets the header's asset ID attribute value
 void setDateTime(long dateTime)
          Sets the header's date-time attribute value to the long millisecond value
 void setEventId(java.lang.String eventId)
          Sets the header's event ID attribute value
 void setEventType(java.lang.String eventType)
          Sets the header's event type attribute value
 void setGeoLocation(java.lang.String geoLocation)
          Sets the header's geographical location attribute value
 void setOriginatingEventId(java.lang.String originatingEventId)
          Sets the header's originating event ID attribute value
 void setPriority(short priority)
          Sets the header's priority attribute value
 void setSourceApplication(java.lang.String s)
          Sets the header's source application attribute value
 void setSourceComponent(java.lang.String s)
          Sets the header's source component attribute value
 void setSourceComponentIdType(java.lang.String s)
          Sets the header's source component ID type attribute value
 void setSourceComponentType(java.lang.String s)
          Sets the header's source component type attribute value
 void setSourceId(java.lang.String targetId)
          Sets the header's source ID attribute value
 void setSourceLocation(java.lang.String s)
          Sets the header's source component location attribute value
 void setSourceLocationType(java.lang.String s)
          Sets the header's source component location type attribute value
 void setSourceSubComponent(java.lang.String s)
          Sets the header's source component subcomponent attribute value
 void setTargetId(java.lang.String targetId)
          Sets the header's target ID attribute value
 java.util.Map toMap()
          Converts the header to a java.util.Map
 
Methods inherited from interface com.ibm.sensorevent.model.IGroup
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

getAssetId

java.lang.String getAssetId()
                            throws SensorEventException
Returns the header's asset ID attribute value

Throws:
SensorEventException

setAssetId

void setAssetId(java.lang.String assetId)
                throws SensorEventException
Sets the header's asset ID attribute value

Throws:
SensorEventException

getDateTime

long getDateTime()
                 throws SensorEventException
Returns the header's date-time attribute value as a long millisecond value

Throws:
SensorEventException

getDateTimeAsString

java.lang.String getDateTimeAsString()
                                     throws SensorEventException
Returns the header's date-time attribute value as an ISO 8601 date string

Throws:
SensorEventException

setDateTime

void setDateTime(long dateTime)
                 throws SensorEventException
Sets the header's date-time attribute value to the long millisecond value

Throws:
SensorEventException

getEventId

java.lang.String getEventId()
                            throws SensorEventException
Returns the header's event ID attribute value

Throws:
SensorEventException

setEventId

void setEventId(java.lang.String eventId)
                throws SensorEventException
Sets the header's event ID attribute value

Throws:
SensorEventException

getEventType

java.lang.String getEventType()
                              throws SensorEventException
Returns the header's event type attribute value

Throws:
SensorEventException

setEventType

void setEventType(java.lang.String eventType)
                  throws SensorEventException
Sets the header's event type attribute value

Throws:
SensorEventException

getGeoLocation

java.lang.String getGeoLocation()
                                throws SensorEventException
Returns the header's geographical location attribute value

Throws:
SensorEventException

setGeoLocation

void setGeoLocation(java.lang.String geoLocation)
                    throws SensorEventException
Sets the header's geographical location attribute value

Throws:
SensorEventException

getOriginatingEventId

java.lang.String getOriginatingEventId()
                                       throws SensorEventException
Returns the header's originating event ID attribute value

Throws:
SensorEventException

setOriginatingEventId

void setOriginatingEventId(java.lang.String originatingEventId)
                           throws SensorEventException
Sets the header's originating event ID attribute value

Throws:
SensorEventException

getPriority

short getPriority()
                  throws SensorEventException
Returns the header's priority attribute value

Throws:
SensorEventException

setPriority

void setPriority(short priority)
                 throws SensorEventException
Sets the header's priority attribute value

Throws:
SensorEventException

getSourceId

java.lang.String getSourceId()
                             throws SensorEventException
Returns the header's source ID attribute value

Throws:
SensorEventException

setSourceId

void setSourceId(java.lang.String targetId)
                 throws SensorEventException
Sets the header's source ID attribute value

Throws:
SensorEventException

getTargetId

java.lang.String getTargetId()
                             throws SensorEventException
Returns the header's target ID attribute value

Throws:
SensorEventException

setTargetId

void setTargetId(java.lang.String targetId)
                 throws SensorEventException
Sets the header's target ID attribute value

Throws:
SensorEventException

getSourceApplication

java.lang.String getSourceApplication()
                                      throws SensorEventException
Returns the header's source application attribute value

Throws:
SensorEventException

setSourceApplication

void setSourceApplication(java.lang.String s)
                          throws SensorEventException
Sets the header's source application attribute value

Throws:
SensorEventException

getSourceComponent

java.lang.String getSourceComponent()
                                    throws SensorEventException
Returns the header's source component attribute value

Throws:
SensorEventException

setSourceComponent

void setSourceComponent(java.lang.String s)
                        throws SensorEventException
Sets the header's source component attribute value

Throws:
SensorEventException

getSourceSubComponent

java.lang.String getSourceSubComponent()
                                       throws SensorEventException
Returns the header's source component subcomponent attribute value

Throws:
SensorEventException

setSourceSubComponent

void setSourceSubComponent(java.lang.String s)
                           throws SensorEventException
Sets the header's source component subcomponent attribute value

Throws:
SensorEventException

getSourceComponentType

java.lang.String getSourceComponentType()
                                        throws SensorEventException
Returns the header's source component type attribute value

Throws:
SensorEventException

setSourceComponentType

void setSourceComponentType(java.lang.String s)
                            throws SensorEventException
Sets the header's source component type attribute value

Throws:
SensorEventException

getSourceComponentIdType

java.lang.String getSourceComponentIdType()
                                          throws SensorEventException
Returns the header's source component ID type attribute value

Throws:
SensorEventException

setSourceComponentIdType

void setSourceComponentIdType(java.lang.String s)
                              throws SensorEventException
Sets the header's source component ID type attribute value

Throws:
SensorEventException

getSourceLocation

java.lang.String getSourceLocation()
                                   throws SensorEventException
Returns the header's source component location attribute value

Throws:
SensorEventException

setSourceLocation

void setSourceLocation(java.lang.String s)
                       throws SensorEventException
Sets the header's source component location attribute value

Throws:
SensorEventException

getSourceLocationType

java.lang.String getSourceLocationType()
                                       throws SensorEventException
Returns the header's source component location type attribute value

Throws:
SensorEventException

setSourceLocationType

void setSourceLocationType(java.lang.String s)
                           throws SensorEventException
Sets the header's source component location type attribute value

Throws:
SensorEventException

getSourceGroup

IGroup getSourceGroup()
                      throws SensorEventException
Returns the header's source component subgroup

Throws:
SensorEventException

toMap

java.util.Map toMap()
                    throws SensorEventException
Converts the header to a java.util.Map

Specified by:
toMap in interface IGroup
Throws:
SensorEventException


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