IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.models.behavior.data
Interface Substituter

All Superinterfaces:
CBActionElement, CBBlock, com.ibm.rational.test.common.models.behavior.CBBlockElement, com.ibm.rational.test.common.models.behavior.edit.CBCloneable, com.ibm.rational.test.common.models.behavior.edit.CBEdit, com.ibm.rational.test.common.models.behavior.cbdata.CBElementModifier, com.ibm.rational.test.common.models.behavior.errors.CBErrorHost, CBNamedElement, com.ibm.rational.test.common.models.behavior.internal.CBTempData, DataSourceConsumer, org.eclipse.emf.ecore.EObject, IAdaptable, LTBlock, com.ibm.rational.test.lt.models.behavior.common.LTElementModifier, com.ibm.rational.test.lt.models.behavior.common.LTInternational, org.eclipse.emf.common.notify.Notifier

public interface Substituter
extends LTBlock, DataSourceConsumer, com.ibm.rational.test.lt.models.behavior.common.LTInternational

A representation of the model object 'Substituter'.

The following features are supported:

See Also:
DataPackage.getSubstituter()

Field Summary
 
Fields inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
MOVE_OLD_PARENT_FLAG
 
Method Summary
 com.ibm.rational.test.lt.models.behavior.data.CreationType getCreatedBy()
          Returns the value of the 'Created By' attribute.
 DataSource getDataSource()
          Returns the value of the 'Data Source' reference
 com.ibm.rational.test.lt.models.behavior.data.DataSourceProxy getDatasourceProxy()
          Returns the value of the 'Datasource Proxy' containment reference
 int getLength()
          Returns the value of the 'Length' attribute
 int getOffset()
          Returns the value of the 'Offset' attribute
 String getRegEx()
          Returns the value of the 'Reg Ex' attribute.
 String getSubstitutedAttribute()
          Returns the value of the 'Substituted Attribute' attribute.
 String getSubstitutedString()
          Returns the value of the 'Substituted String' attribute.
 int getSubstitutionLength(String charset)
          Returns the number of bytes that will be substituted
 com.ibm.rational.test.lt.models.behavior.data.SubstitutionType getSubstitutionType()
          Returns the value of the 'Substitution Type' containment reference
 int getUILength()
           
 int getUIOffset()
           
 String getUIString()
           
 String getVaraibleName()
          Returns the value of the 'Varaible Name' attribute.
 boolean isEncode()
          Returns the value of the 'Encode' attribute
 void setCreatedBy(com.ibm.rational.test.lt.models.behavior.data.CreationType value)
          Sets the value of the 'Created By' attribute
 void setDataSource(DataSource value)
          Sets the value of the 'Data Source' reference
 void setDatasourceProxy(com.ibm.rational.test.lt.models.behavior.data.DataSourceProxy value)
          Sets the value of the 'Datasource Proxy' containment reference
 void setEncode(boolean value)
          Sets the value of the 'Encode' attribute
 void setLength(int value)
          Sets the value of the 'Length' attribute
 void setOffset(int value)
          Sets the value of the 'Offset' attribute
 void setRegEx(String value)
          Sets the value of the 'Reg Ex' attribute
 void setSubstitutedAttribute(String value)
          Sets the value of the 'Substituted Attribute' attribute
 void setSubstitutedString(String value)
          Sets the value of the 'Substituted String' attribute
 void setSubstitutionType(com.ibm.rational.test.lt.models.behavior.data.SubstitutionType value)
          Sets the value of the 'Substitution Type' containment reference
 void setUILength(int newLength)
           
 void setUIOffset(int newOffset)
           
 void setUIString(String newString)
           
 void setVaraibleName(String value)
          Sets the value of the 'Varaible Name' attribute
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.common.LTBlock
addProxy, createProxy, isProxyReference, processRemoval, removeProxy
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlock
getActions, getCBErrors, getCBRequirementTarget, processRemoval, setCBRequirementTarget
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlockElement
isControlBlock
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBActionElement
canDisable, canEnable, enable, getAction, getBooleanProperty, getByteProperty, getCharProperty, getDisabledCount, getDoubleProperty, getFloatProperty, getInheritedCBActionElements, getIntProperty, getLongProperty, getMovingFrom, getParent, getShortProperty, getStringProperty, getTransformID, getType, isAlwaysLog, isEnabled, isMoving, move, resetDisabledCount, setAction, setAlwaysLog, setDisabledCount, setEnabled, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTransformID, setType, 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
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
canCopy, canMove, doCopy, doMove, findProblemsWithCopy, findProblemsWithMove
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.errors.CBErrorHost
canHostCBErrors, isErrorGenerator
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.data.DataSourceConsumer
unlink
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.common.LTInternational
isAsciified, modifyText, modifyText, toDisplay, toModel
 

Method Detail

getSubstitutedAttribute

String getSubstitutedAttribute()
Returns the value of the 'Substituted Attribute' attribute. The default value is "".

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

Returns:
the value of the 'Substituted Attribute' attribute.
See Also:
Substituter.setSubstitutedAttribute(String), DataPackage.getSubstituter_SubstitutedAttribute()

setSubstitutedAttribute

void setSubstitutedAttribute(String value)
Sets the value of the 'Substituted Attribute' attribute.

Parameters:
value - the new value of the 'Substituted Attribute' attribute.
See Also:
Substituter.getSubstitutedAttribute()

getLength

int getLength()
Returns the value of the 'Length' attribute.

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

Returns:
the value of the 'Length' attribute.
See Also:
Substituter.setLength(int), DataPackage.getSubstituter_Length()

getSubstitutionLength

int getSubstitutionLength(String charset)
Returns the number of bytes that will be substituted.

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

Returns:
number of bytes that will be substituted.

setLength

void setLength(int value)
Sets the value of the 'Length' attribute.

Parameters:
value - the new value of the 'Length' attribute.
See Also:
Substituter.getLength()

getOffset

int getOffset()
Returns the value of the 'Offset' attribute.

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

Returns:
the value of the 'Offset' attribute.
See Also:
Substituter.setOffset(int), DataPackage.getSubstituter_Offset()

setOffset

void setOffset(int value)
Sets the value of the 'Offset' attribute.

Parameters:
value - the new value of the 'Offset' attribute.
See Also:
Substituter.getOffset()

getRegEx

String getRegEx()
Returns the value of the 'Reg Ex' attribute. The default value is "".

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

Returns:
the value of the 'Reg Ex' attribute.
See Also:
Substituter.setRegEx(String), DataPackage.getSubstituter_RegEx()

setRegEx

void setRegEx(String value)
Sets the value of the 'Reg Ex' attribute.

Parameters:
value - the new value of the 'Reg Ex' attribute.
See Also:
Substituter.getRegEx()

getSubstitutedString

String getSubstitutedString()
Returns the value of the 'Substituted String' attribute. The default value is "".

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

Returns:
the value of the 'Substituted String' attribute.
See Also:
Substituter.setSubstitutedString(String), DataPackage.getSubstituter_SubstitutedString()

setSubstitutedString

void setSubstitutedString(String value)
Sets the value of the 'Substituted String' attribute.

Parameters:
value - the new value of the 'Substituted String' attribute.
See Also:
Substituter.getSubstitutedString()

isEncode

boolean isEncode()
Returns the value of the 'Encode' attribute.

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

Returns:
the value of the 'Encode' attribute.
See Also:
Substituter.setEncode(boolean), DataPackage.getSubstituter_Encode()

setEncode

void setEncode(boolean value)
Sets the value of the 'Encode' attribute.

Parameters:
value - the new value of the 'Encode' attribute.
See Also:
Substituter.isEncode()

getVaraibleName

String getVaraibleName()
Returns the value of the 'Varaible Name' attribute. The default value is "".

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

Returns:
the value of the 'Varaible Name' attribute.
See Also:
Substituter.setVaraibleName(String), DataPackage.getSubstituter_VaraibleName()

setVaraibleName

void setVaraibleName(String value)
Sets the value of the 'Varaible Name' attribute.

Parameters:
value - the new value of the 'Varaible Name' attribute.
See Also:
Substituter.getVaraibleName()

getDataSource

DataSource getDataSource()
Returns the value of the 'Data Source' reference.

If the meaning of the 'Data Source' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Data Source' reference.
See Also:
Substituter.setDataSource(DataSource), DataPackage.getSubstituter_DataSource()

setDataSource

void setDataSource(DataSource value)
Sets the value of the 'Data Source' reference.

Parameters:
value - the new value of the 'Data Source' reference.
See Also:
Substituter.getDataSource()

getDatasourceProxy

com.ibm.rational.test.lt.models.behavior.data.DataSourceProxy getDatasourceProxy()
Returns the value of the 'Datasource Proxy' containment reference.

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

Returns:
the value of the 'Datasource Proxy' containment reference.
See Also:
Substituter.setDatasourceProxy(DataSourceProxy), DataPackage.getSubstituter_DatasourceProxy()

setDatasourceProxy

void setDatasourceProxy(com.ibm.rational.test.lt.models.behavior.data.DataSourceProxy value)
Sets the value of the 'Datasource Proxy' containment reference.

Parameters:
value - the new value of the 'Datasource Proxy' containment reference.
See Also:
Substituter.getDatasourceProxy()

getCreatedBy

com.ibm.rational.test.lt.models.behavior.data.CreationType getCreatedBy()
Returns the value of the 'Created By' attribute. The default value is "AUTOMATIC". The literals are from the enumeration CreationType.

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

Returns:
the value of the 'Created By' attribute.
See Also:
CreationType, Substituter.setCreatedBy(CreationType), DataPackage.getSubstituter_CreatedBy()

setCreatedBy

void setCreatedBy(com.ibm.rational.test.lt.models.behavior.data.CreationType value)
Sets the value of the 'Created By' attribute.

Parameters:
value - the new value of the 'Created By' attribute.
See Also:
CreationType, Substituter.getCreatedBy()

getSubstitutionType

com.ibm.rational.test.lt.models.behavior.data.SubstitutionType getSubstitutionType()
Returns the value of the 'Substitution Type' containment reference.

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

Returns:
the value of the 'Substitution Type' containment reference.
See Also:
Substituter.setSubstitutionType(SubstitutionType), DataPackage.getSubstituter_SubstitutionType()

setSubstitutionType

void setSubstitutionType(com.ibm.rational.test.lt.models.behavior.data.SubstitutionType value)
Sets the value of the 'Substitution Type' containment reference.

Parameters:
value - the new value of the 'Substitution Type' containment reference.
See Also:
Substituter.getSubstitutionType()

getUIOffset

int getUIOffset()

getUILength

int getUILength()

getUIString

String getUIString()

setUIOffset

void setUIOffset(int newOffset)

setUILength

void setUILength(int newLength)

setUIString

void setUIString(String newString)

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.