IBM Rational Performance Tester SDK

com.ibm.rational.test.common.models.behavior
Interface CBTest

All Superinterfaces:
com.ibm.rational.test.common.models.behavior.CBAssetMigration, com.ibm.rational.test.common.models.behavior.errors.CBErrorHost, CBNamedElement, com.ibm.rational.test.common.models.behavior.internal.CBTempData, org.eclipse.emf.ecore.EObject, IAdaptable, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
LTTest

public interface CBTest
extends CBNamedElement, com.ibm.rational.test.common.models.behavior.CBAssetMigration, com.ibm.rational.test.common.models.behavior.errors.CBErrorHost

CBTest.java


Method Summary
 List getActions()
          Return a list with the actions contained in the Block.
 String getBehaviorName()
          Gets the name of the test suite behavior
 org.eclipse.emf.common.util.EList getCBErrors()
          Returns the value of the 'CB Errors' containment reference list.
 List[] getInheritedCBActionElements()
          Get the list of Action Elements that are contained by this test.
 String getResource()
          Get the resource setting of the implementor
 String getResourceType()
          Get the type of resource.
 org.eclipse.emf.common.util.EList getRTBLocations()
          Returns the value of the 'RTB Locations' containment reference list.
 org.eclipse.hyades.models.common.facades.behavioral.ITest getTest()
          Returns the ITest
 String getType()
          Get the Actual type of this class.
 CBVersion getVersion()
          get test version (to be overloaded by descendants)
 boolean isOlderVersion()
          This method detects if this test was created by an older version of the product and specifically, if the version of the test is older than the current version.
 void regenerateId()
          FOR INTERNAL USE ONLY
 void save()
          Method to save the test suite associated with this test.
 void save(IFile file)
          Method to save the test suite associated with this test into a new test suite file.
 Object[] saveAndReturnInfo(IFile file)
          Method to save the test suite associated with this test into a new test suite file.
 void saveToUnopenedTest(IFile file)
          Method to save the test suite associated with this test into a new resource.
 void search(com.ibm.rational.test.common.models.behavior.util.CBMRunnable runnable)
          Perform a search using the runnable by going thru the entire test until the runnable indicates its done.
 void setBehaviorName(String name)
          Sets the name of the behavior
 void setName(String name)
          Set the name of the element.
 void setResource(String resource)
          Sets the resource for the implementor.
 void setTest(org.eclipse.hyades.models.common.facades.behavioral.ITest test)
          Set the ITest.
 void setType(String type)
          Set the type that this ITest represents.
 void unload()
          Unload the testsuite when its no longer needed so the associated temp folders may be cleaned up.
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBNamedElement
getDescription, getId, getName, getStopId, setDescription, setId
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.internal.CBTempData
getTempAttribute, getTempAttribute, getTempAttributes, setTempAttribute, setTempAttribute, unsetTempAttribute
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBAssetMigration
migrate, needMigration
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.errors.CBErrorHost
canHostCBErrors, isErrorGenerator
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getCBErrors

org.eclipse.emf.common.util.EList getCBErrors()
Returns the value of the 'CB Errors' containment reference list. The list contents are of type CBError.

If the meaning of the 'CB Errors' containment reference list isn't clear, there really should be more of a description here...

Specified by:
getCBErrors in interface com.ibm.rational.test.common.models.behavior.errors.CBErrorHost
Returns:
the value of the 'CB Errors' containment reference list.
See Also:
BehaviorPackage.getCBTest_CBErrors()

getRTBLocations

org.eclipse.emf.common.util.EList getRTBLocations()
Returns the value of the 'RTB Locations' containment reference list. The list contents are of type CBLocation.

If the meaning of the 'RTB Locations' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'RTB Locations' containment reference list.
See Also:
BehaviorPackage.getCBTest_RTBLocations()

getTest

org.eclipse.hyades.models.common.facades.behavioral.ITest getTest()
Returns the ITest

Returns:
the ITest

setTest

void setTest(org.eclipse.hyades.models.common.facades.behavioral.ITest test)
Set the ITest. This will recursively create all the elements in the ITest and retrieve the properties in order to populate any EMF generated classes that inherits from this class.

Parameters:
test - - the ITest to set

getType

String getType()
Get the Actual type of this class. The actual type identifies the class that this ITest represents.

Returns:
The type of the class as a fully qualified class name.

setType

void setType(String type)
Set the type that this ITest represents.

Parameters:
type - The actual class of the ITest as a fully qualified class name.

getBehaviorName

String getBehaviorName()
Gets the name of the test suite behavior

Returns:
- name of the implementor

setBehaviorName

void setBehaviorName(String name)
Sets the name of the behavior

Parameters:
name - - name of the implementor, typically _behavior

getResource

String getResource()
Get the resource setting of the implementor

Returns:
- resource (fully qualified path of the class to generate) name

setResource

void setResource(String resource)
Sets the resource for the implementor.

Parameters:
resource - to set

getActions

List getActions()
Return a list with the actions contained in the Block. In order to add objects simply add to the list. Objects can also be removed by using the standard List methods.

Returns:
A list with the contained IActions.

save

void save()
          throws Exception
Method to save the test suite associated with this test. This method will persist the resource associated with the test. This will result in a .testsuite file on disk.

Throws:
Exception - - this re-throws any exception during the underlying save operation

save

void save(IFile file)
          throws Exception

Method to save the test suite associated with this test into a new test suite file. This will be typically used by 'Save As' operations. The IFile that is passed in should be the workspace relative path to the location of the new test suite file. This method derives the name of test from the file name by stripping the prefix path and the extension suffix.

Note, this method does not modify the properties of this test.

Parameters:
file - The IFile for the location of the new test suite file.
Throws:
Exception - The input file has invalid path or invalid name. #see saveAndReturnInfo(IFile)

saveAndReturnInfo

Object[] saveAndReturnInfo(IFile file)
                           throws Exception

Method to save the test suite associated with this test into a new test suite file. This will be typically used by 'Save As' operations. The IFile that is passed in should be the workspace relative path to the location of the new test suite file. This method derives the name of test from the file name by stripping the prefix path and the extension suffix.

Note, this method does not modify the properties of this test.

Parameters:
file - The IFile for the location of the new test suite file.
Returns:
The information about the new test (these cannot be found in the this CBTest after the method returns. The data is returned as an array of Objects. There are at least three (as of version 8.1.1) elements in the array:
  • o[0] is String representing name of the new test
  • o[1] is String representing ID of the new test
  • o[2] is URI representing org.eclipse.emf.common.util.URI of the new test
    Throws:
    Exception - The input file has invalid path or invalid name.
    Since:
    8.1.1
    See Also:
    URI, CBTest.save(IFile)

  • saveToUnopenedTest

    void saveToUnopenedTest(IFile file)
                            throws Exception
    Method to save the test suite associated with this test into a new resource. This method will leave the file that is opened in tact and create a new file on disk. The IFile that is passed in should be the workspace relative path to the location of the new testsuite file. This method derives the name of test from the file name by stripping the prefix path and the extension suffix.

    Parameters:
    file - IFile - the IFile for the new location where this is to be saved.
    Throws:
    Exception - - throws an exception if the input file has invalid path or invalid name.

    getInheritedCBActionElements

    List[] getInheritedCBActionElements()
    Get the list of Action Elements that are contained by this test. The list will contain CBActionElements.

    Returns:
    A list of CBActionElements

    getResourceType

    String getResourceType()
    Get the type of resource. This is used when we set the resource string later (as a result of a call to setName()...) Subclasses should override this method to return different types (i.e., 'schedule') as necessary...


    setName

    void setName(String name)
    Set the name of the element.

    Specified by:
    setName in interface CBNamedElement
    Parameters:
    name - of element

    search

    void search(com.ibm.rational.test.common.models.behavior.util.CBMRunnable runnable)
    Perform a search using the runnable by going thru the entire test until the runnable indicates its done.

    Parameters:
    runnable -

    unload

    void unload()
    Unload the testsuite when its no longer needed so the associated temp folders may be cleaned up.


    regenerateId

    void regenerateId()
    FOR INTERNAL USE ONLY


    getVersion

    CBVersion getVersion()
    get test version (to be overloaded by descendants)


    isOlderVersion

    boolean isOlderVersion()
    This method detects if this test was created by an older version of the product and specifically, if the version of the test is older than the current version.

    Returns:
    boolean

    IBM Rational Performance Tester SDK

    © Copyright IBM Corp. 2012. All rights reserved.