IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.execution.core
Interface IContentVP

All Superinterfaces:
com.ibm.rational.test.lt.kernel.services.IRPTEventGenerator, IVerificationPoint

public interface IContentVP
extends IVerificationPoint, com.ibm.rational.test.lt.kernel.services.IRPTEventGenerator

A IContentVP is a verification point capable of verifying arbitrary String content and returning a verdict.

Since:
6.1.2
See Also:
IVerificationPoint

Method Summary
 void exit(String reason)
          Terminates the current verification point evaluation because of the supplied error condition.
 StringBuffer getContent()
          Returns the content to be verified.
 Object getTempAttribute(String name)
          Returns the value associated with the specified name.
 void setTempAttribute(String name, Object value)
          Sets the value of the specified attribute name.
 org.eclipse.hyades.test.common.event.VerdictEvent verifyContentVP(String content)
          Evaluate the content VP and return a verdict event.
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.services.IRPTEventGenerator
getEventBehavior, getEventType, setEventBehavior
 

Method Detail

getContent

StringBuffer getContent()
Returns the content to be verified. Used by IContentVPElement during the verify to gain access to the content.

Returns:
the content under verification
Since:
6.1.2

getTempAttribute

Object getTempAttribute(String name)
Returns the value associated with the specified name. If no value has been set using setTempAttribute then a null is returned. This feature is to be used by IContentVPElement during execution to communication with other elements belonging to the same group and will only be available for one execution period.

Parameters:
name - the attribute name
Returns:
The attribute value or null if it DNE.
Since:
6.1.2
See Also:
IContentVP.setTempAttribute(String, Object)

setTempAttribute

void setTempAttribute(String name,
                      Object value)
Sets the value of the specified attribute name.

Parameters:
name - Name of the attribute.
value - Value of the attribute.
Since:
6.1.2
See Also:
IContentVP.getTempAttribute(String)

exit

void exit(String reason)
Terminates the current verification point evaluation because of the supplied error condition. IContentVPElement can use this when an abnormal error condition is encountered during the evaluation.

Parameters:
reason - the reason to exit VP evaluation
Since:
6.1.2
See Also:
IContentVPElement

verifyContentVP

org.eclipse.hyades.test.common.event.VerdictEvent verifyContentVP(String content)
Evaluate the content VP and return a verdict event. If content is null then it is an indication there were problems retrieving the content and a failed verdict will be returned.

Parameters:
content - The content to be verified against, null if content was unable to be retrieved.
Returns:
A TPTP verdict event
Since:
6.1.2

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.