IBM Rational Performance Tester SDK

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

All Superinterfaces:
com.ibm.rational.test.common.models.behavior.edit.CBCloneable, 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:
Arbitrary, BuiltInDataSource, CBAction, CBBlock, com.ibm.rational.test.common.models.behavior.CBBlockElement, CBComment, CBLoop, com.ibm.rational.test.common.models.behavior.CBNameValuePair, CBTestComponent, CBTestInvocation, com.ibm.rational.test.common.models.behavior.CBTransaction, CBVersion, com.ibm.rational.test.lt.models.behavior.data.CoreHarvester, CorrelationHarvester, Datapool, DatapoolHarvester, DataSource, LTAnnotation, LTBlock, LTComment, LTCondition, LTContainer, LTFalseContainer, LTFeature, LTIf, LTLeftOperand, LTLoop, LTNameTypeValue, com.ibm.rational.test.lt.models.behavior.common.LTNameValuePair, LTOperand, LTOptions, LTResources, LTRightOperand, LTTransaction, LTTrueContainer, Option, Substituter, VerificationPoint, VPContent, VPString
All Known Implementing Classes:
com.ibm.rational.test.common.models.behavior.impl.CBActionElementImpl, com.ibm.rational.test.common.models.behavior.impl.CBActionImpl, com.ibm.rational.test.common.models.behavior.impl.CBBlockElementImpl, com.ibm.rational.test.common.models.behavior.impl.CBBlockImpl, LTBlockImpl, OptionImpl, ProxyElementImpl, VerificationPointImpl

public interface CBActionElement
extends CBNamedElement, com.ibm.rational.test.common.models.behavior.edit.CBCloneable

The ActionElement contains behavior that is common to all classes that contain IActions. This behavior manages properties on IActions. Therefore we provide methods that get and set the properties.

The following features are supported:

See Also:
BehaviorPackage.getCBActionElement()

Method Summary
 boolean canDisable()
          Returns true if the element can be disabled, false otherwise
 boolean canEnable()
          Return true if the element can be enabled, false otherwise
 IStatus enable(boolean enable)
           
 org.eclipse.hyades.models.common.facades.behavioral.IAction getAction()
          Return the IAction.
 boolean getBooleanProperty(String name)
          Get the property with the corresponding name.
 byte getByteProperty(String name)
          Get the property with the corresponding name.
 char getCharProperty(String name)
          Get the property with the corresponding name.
 int getDisabledCount()
          Returns the value of the 'Disabled Count' attribute.
 double getDoubleProperty(String name)
          Get the property with the corresponding name.
 float getFloatProperty(String name)
          Get the property with the corresponding name.
 List[] getInheritedCBActionElements()
          Retrieve all CBActionElements contained in this block.
 int getIntProperty(String name)
          Get the property with the corresponding name.
 long getLongProperty(String name)
          Get the property with the corresponding name.
 CBElementHost getMovingFrom()
          If this element is being moved, where is it moving from?
 CBActionElement getParent()
          for INTERNAL USE ONLY
 short getShortProperty(String name)
          Get the property with the corresponding name.
 String getStringProperty(String name)
          Get the property with the corresponding name.
 String getTransformID()
          Returns the value of the 'Transform ID' attribute
 String getType()
          Get the Actual type of this class.
 boolean isAlwaysLog()
          Returns the value of the 'Always Log' attribute.
 boolean isEnabled()
           If the meaning of the 'Enabled' attribute isn't clear, there really should be more of a description here...
 boolean isMoving()
          Is this element in the process of being being moved?
 void move(CBActionElement newParent, int index)
          Move this model element to a new Parent.
 void resetDisabledCount()
           
 void setAction(org.eclipse.hyades.models.common.facades.behavioral.IAction action)
          Set the IAction.
 void setAlwaysLog(boolean value)
          Sets the value of the 'Always Log' attribute
 void setDisabledCount(int value)
          Sets the value of the 'Disabled Count' attribute
 void setEnabled(boolean enable)
          This boolean is used to determine whether or not the CBActionElement is enabled
 void setProperty(String name, boolean value)
          Set the property with the corresponding name.
 void setProperty(String name, byte value)
          Set the property with the corresponding name.
 void setProperty(String name, char value)
          Set the property with the corresponding name.
 void setProperty(String name, double value)
          Set the property with the corresponding name.
 void setProperty(String name, float value)
          Set the property with the corresponding name.
 void setProperty(String name, int value)
          Set the property with the corresponding name.
 void setProperty(String name, long value)
          Set the property with the corresponding name.
 void setProperty(String name, short value)
          Set the property with the corresponding name.
 void setProperty(String name, String value)
          Set the property with the corresponding name.
 void setTransformID(String value)
          Sets the value of the 'Transform ID' attribute
 void setType(String type)
          Set the type that this IAction represents.
 IStatus validate()
           
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBNamedElement
getDescription, getId, getName, getStopId, setDescription, setId, setName
 
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.edit.CBCloneable
doClone, isCloneable
 
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

isEnabled

boolean isEnabled()

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


setEnabled

void setEnabled(boolean enable)
This boolean is used to determine whether or not the CBActionElement is enabled.


getDisabledCount

int getDisabledCount()
Returns the value of the 'Disabled Count' attribute. The default value is "0". This boolean is used to determine whether or not the CBActionElement is enabled.

Returns:
the value of the 'Disabled Count' attribute.
See Also:
CBActionElement.setDisabledCount(int), BehaviorPackage.getCBActionElement_DisabledCount()

setDisabledCount

void setDisabledCount(int value)
Sets the value of the 'Disabled Count' attribute.

Parameters:
value - the new value of the 'Disabled Count' attribute.
See Also:
CBActionElement.getDisabledCount()

getTransformID

String getTransformID()
Returns the value of the 'Transform ID' attribute.

If the meaning of the 'Transform ID' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Transform ID' attribute.
See Also:
CBActionElement.setTransformID(String), BehaviorPackage.getCBActionElement_TransformID()

setTransformID

void setTransformID(String value)
Sets the value of the 'Transform ID' attribute.

Parameters:
value - the new value of the 'Transform ID' attribute.
See Also:
CBActionElement.getTransformID()

isAlwaysLog

boolean isAlwaysLog()
Returns the value of the 'Always Log' attribute. The default value is "false".

If the meaning of the 'Always Log' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Always Log' attribute.
See Also:
CBActionElement.setAlwaysLog(boolean), BehaviorPackage.getCBActionElement_AlwaysLog()

setAlwaysLog

void setAlwaysLog(boolean value)
Sets the value of the 'Always Log' attribute.

Parameters:
value - the new value of the 'Always Log' attribute.
See Also:
CBActionElement.isAlwaysLog()

resetDisabledCount

void resetDisabledCount()


canEnable

boolean canEnable()
Return true if the element can be enabled, false otherwise.


canDisable

boolean canDisable()
Returns true if the element can be disabled, false otherwise.


enable

IStatus enable(boolean enable)
Parameters:
enable - - true to turn on enable,false otherwise
Returns:
whether the enable action was successful or not

getInheritedCBActionElements

List[] getInheritedCBActionElements()
Retrieve all CBActionElements contained in this block.

Returns:
A list of CBActionElements

getAction

org.eclipse.hyades.models.common.facades.behavioral.IAction getAction()
Return the IAction.

Returns:
The IAction

setAction

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

Parameters:
action - The IAction to set.

getType

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

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

setType

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

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

setProperty

void setProperty(String name,
                 String value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 char value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 byte value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 short value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 int value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 long value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 float value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 double value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

setProperty

void setProperty(String name,
                 boolean value)
Set the property with the corresponding name.

Parameters:
name - The name of the property.
value - The value of the property.

getStringProperty

String getStringProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getIntProperty

int getIntProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getCharProperty

char getCharProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getBooleanProperty

boolean getBooleanProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getByteProperty

byte getByteProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getShortProperty

short getShortProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getLongProperty

long getLongProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getFloatProperty

float getFloatProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getDoubleProperty

double getDoubleProperty(String name)
Get the property with the corresponding name.

Parameters:
name - The name of the property.

getParent

CBActionElement getParent()
for INTERNAL USE ONLY

Returns:
parent of this CBActionElement in the model

move

void move(CBActionElement newParent,
          int index)
Move this model element to a new Parent. The new parent should be an instance of a CBElementHost. This element is placed at index

Parameters:
newParent -
index -

isMoving

boolean isMoving()
Is this element in the process of being being moved?

Returns:
- true if being moved, false otherwise

getMovingFrom

CBElementHost getMovingFrom()
If this element is being moved, where is it moving from?

Returns:
- the old parent of this element, null if not being moved.

validate

IStatus validate()

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.