com.ibm.sensorevent.model.generic
Interface IGenericEvent

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ISensorEvent
All Known Implementing Classes:
GenericEvent, IBMSensorEvent

public interface IGenericEvent
extends java.io.Serializable

IGenericEvent is the interface representing the class GenericEvent.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addGroup(IGenericGroup group)
          Adds a group to this event
 IGenericGroup getGroup(java.lang.String id)
          Returns the group with the specified name
 java.util.Collection getGroups()
          Returns this event's groups as a collection of IGenericGroup
 java.lang.String getName()
          Returns the event's name
 void removeGroups()
          Removes all groups from this event
 void setGroups(java.util.Collection groups)
          Sets this event's collection of groups
 void setName(java.lang.String id)
          Sets the name of this event
 IGenericGroup traverseGroupPath(java.util.List path)
          Returns the last nested group specified in path.
 

Field Detail

COPYRIGHT

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

getName

java.lang.String getName()
Returns the event's name


setName

void setName(java.lang.String id)
             throws SensorEventException
Sets the name of this event

Throws:
SensorEventException

addGroup

void addGroup(IGenericGroup group)
              throws SensorEventException
Adds a group to this event

Throws:
SensorEventException

getGroup

IGenericGroup getGroup(java.lang.String id)
                       throws SensorEventException
Returns the group with the specified name

Throws:
SensorEventException

getGroups

java.util.Collection getGroups()
Returns this event's groups as a collection of IGenericGroup


removeGroups

void removeGroups()
Removes all groups from this event


setGroups

void setGroups(java.util.Collection groups)
               throws SensorEventException
Sets this event's collection of groups

Throws:
SensorEventException

traverseGroupPath

IGenericGroup traverseGroupPath(java.util.List path)
                                throws SensorEventException
Returns the last nested group specified in path. If this event contains group A which contains group B which contains group C, a path containing strings "A", "B", "C" returns group C.

Throws:
SensorEventException


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