TPTP 4.1.0 Testing Tools Project
Public API Specification

org.eclipse.hyades.test.common.event
Class ExecutionEvent

java.lang.Object
  extended byorg.eclipse.hyades.test.common.event.ExecutionEvent
All Implemented Interfaces:
IEventConstants
Direct Known Subclasses:
InvocationEvent, LoopEvent, MessageEvent, TimedEvent, TypedEvent, VerdictEvent

public class ExecutionEvent
extends java.lang.Object
implements IEventConstants

This is a flat class packaged in the execution environment and it mirrors the org.eclipse.hyades.models.common.testprofile.TPFExecutionEvent


Field Summary
 
Fields inherited from interface org.eclipse.hyades.test.common.event.IEventConstants
CONFLICT_IGNORE, CONFLICT_NONE, CONFLICT_OVERWRITE, CONFLICT_OVERWRITE_IF_EARLIEST, CONFLICT_OVERWRITE_IF_LATEST, NOT_INITIALIZED_VALUE, ROOT_PARENT
 
Constructor Summary
ExecutionEvent()
           
 
Method Summary
protected  void addXMLAttributes(java.lang.StringBuffer xml)
          Add the attributes to the xml StringBuffer that is used by the toString() method.
protected  void addXMLProperties(java.lang.StringBuffer xml)
          Add the property attributes to the xml StringBuffer that is used by the toString() method.
 int getConflict()
           
 java.lang.String getEventType()
           
 java.lang.String getId()
          Returns the id of this event.
 java.lang.String getName()
           
 java.lang.String getOwnerId()
          Returns the owner id of this event.
 java.lang.String getParentId()
          Returns the ID of the parent event
 java.util.ArrayList getProperties()
           
 java.lang.String getSortBy()
           
 java.lang.String getText()
          Returns the text of this event.
 long getTimestamp()
          Returns the timestamp of this event.
protected  java.lang.String getXMLPropertyRoot()
          Returns the string that is used as the tag for property xml fragment generated by the toString() method.
protected  java.lang.String getXMLRoot()
          Returns the string that is used as the root of the xml fragment generated by the toString() method.
 void setConflict(int conflict)
          This attribute indicates what should be done by the execution history loader if it finds an existing event with the same credentials (hierarchical id).
 void setEventType(java.lang.String eventType)
          This attribute is optional.
 void setId(java.lang.String value)
          Sets the id of this event.
 void setName(java.lang.String name)
          If this attribute is speicified, the execution history viewer will use it as the label of the tree element for this event.
 void setOwnerId(java.lang.String value)
          Sets the owner id of this event.
 void setParentId(java.lang.String parentId)
          Sets the ID of the parent event
 void setSortBy(java.lang.String sortBy)
          Set this attribute if this event needs to be sorted within the scope of its immediate parent in the execution history.
 void setText(java.lang.String value)
          Sets the text of this event.
 void setTimestamp(long value)
          Sets the timestamp of this event.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExecutionEvent

public ExecutionEvent()
Method Detail

getId

public java.lang.String getId()
Returns the id of this event.

Returns:
String

setId

public void setId(java.lang.String value)
Sets the id of this event.

Parameters:
value -

getParentId

public java.lang.String getParentId()
Returns the ID of the parent event

Returns:
String

setParentId

public void setParentId(java.lang.String parentId)
Sets the ID of the parent event

Parameters:
parentId -

getOwnerId

public java.lang.String getOwnerId()
Returns the owner id of this event.

Returns:
String

setOwnerId

public void setOwnerId(java.lang.String value)
Sets the owner id of this event.

Parameters:
value -

getTimestamp

public long getTimestamp()
Returns the timestamp of this event.

Returns:
String

setTimestamp

public void setTimestamp(long value)
Sets the timestamp of this event. The timestamp is set by the toString() method if this getTimestamp() returns 0.

Parameters:
value -

getText

public java.lang.String getText()
Returns the text of this event.

Returns:
String

setText

public void setText(java.lang.String value)
Sets the text of this event.

Returns:
String

getEventType

public java.lang.String getEventType()
Returns:
Returns the eventType.

setEventType

public void setEventType(java.lang.String eventType)
This attribute is optional. If provided, the execution history viewer, will query the extension point that will need to be provided, for the label of the tree element for this event, in the execution history viewer.

Parameters:
eventType - The eventType to set.

getName

public java.lang.String getName()
Returns:
Returns the name.

setName

public void setName(java.lang.String name)
If this attribute is speicified, the execution history viewer will use it as the label of the tree element for this event. However, if the eventType is specified, the it will query the corresponding extension point for the label text.

Parameters:
name - The name to set.

getSortBy

public java.lang.String getSortBy()
Returns:
Returns the sortBy.

setSortBy

public void setSortBy(java.lang.String sortBy)
Set this attribute if this event needs to be sorted within the scope of its immediate parent in the execution history. This attribute does not make it all the way to the execution history model but is used by the loaders to figure out sorting.

Parameters:
sortBy - The sortBy to set.

getConflict

public int getConflict()
Returns:
Returns the conflict.

setConflict

public void setConflict(int conflict)
This attribute indicates what should be done by the execution history loader if it finds an existing event with the same credentials (hierarchical id). Default behavior isto not worry about conflicts and just insert this event into the execution history

Parameters:
conflict - The conflict to set.

getProperties

public java.util.ArrayList getProperties()
Returns:
Returns the properties.

toString

public java.lang.String toString()
See Also:
Object.toString()

getXMLRoot

protected java.lang.String getXMLRoot()
Returns the string that is used as the root of the xml fragment generated by the toString() method.

Returns:
a not null String

getXMLPropertyRoot

protected java.lang.String getXMLPropertyRoot()
Returns the string that is used as the tag for property xml fragment generated by the toString() method.

Returns:
a not null String

addXMLAttributes

protected void addXMLAttributes(java.lang.StringBuffer xml)
Add the attributes to the xml StringBuffer that is used by the toString() method.

Parameters:
xml -

addXMLProperties

protected void addXMLProperties(java.lang.StringBuffer xml)
Add the property attributes to the xml StringBuffer that is used by the toString() method.

Parameters:
xml -

TPTP 4.1.0 Testing Tools Project
Public API Specification