|
IBM Rational Functional Tester Version 8.1.1000 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.rational.test.ft.object.map.MappedTestObject
public class MappedTestObject
| Field Summary | |
|---|---|
static com.rational.test.ft.util.FtDebug |
debug
|
| Fields inherited from interface com.rational.test.ft.object.map.IMappedTestObject |
|---|
CHILDREN, IGNOREOWNER, NAMEINSCRIPT, OWNED, OWNER, PARENT, SPYMAPPEDTESTOBJECT, TRANSIENT_USED, TRANSIENTNAME, VOM_CRC, VOM_DD, VOM_ID, VOM_RECTANGLE |
| Fields inherited from interface com.rational.test.ft.script.IMapPropertyName |
|---|
CLASS, DESCRIPTION, DESCRIPTIONOBJECT, DESCRIPTIVENAME, DOMAIN, MAPID, NESTEDCOMMENT, PROXYCLASSNAME, ROLE, SCRIPTNAME, SIMPLENAME, STATE, TESTOBJECTCLASSNAME |
| Constructor Summary | |
|---|---|
MappedTestObject()
|
|
MappedTestObject(com.rational.test.ft.object.map.IMappedTestObject mto)
|
|
MappedTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mto,
boolean saveReferenceToSpyMto)
|
|
| Method Summary | |
|---|---|
void |
clearId()
Clears the map-relative unique identifier. |
void |
debugDisplay()
|
int |
getChildCount(boolean allChildren)
Returns the count of children associated with this MappedTestObject. |
com.rational.test.ft.object.map.IMappedTestObject[] |
getChildren()
Returns the known list of children associated with this MappedTestObject. |
java.lang.Object |
getClassName()
Defines the required class name recognition property. |
java.lang.String |
getDescriptiveName()
Returns the descriptive name administrative property. |
java.lang.String |
getDomainName()
Returns the domain administrative property. |
java.lang.String |
getId()
Assigns, to every test object added to a map, a unique identifier relative to the associated map . |
com.rational.test.ft.object.map.IObjectMapPropertySet |
getMapProperties()
|
java.lang.String |
getNameInScript()
Check to see if this test object knows what its name is in the context of a running test script. |
com.rational.test.ft.object.map.IMappedTestObject[] |
getOwned()
Returns the known list of owned children associated with this MappedTestObject. |
com.rational.test.ft.object.map.IMappedTestObject |
getOwner()
Returns the owner object. |
com.rational.test.ft.object.map.IMappedTestObject |
getParent()
Returns the parent object. |
java.lang.Object |
getProperty(java.lang.String property)
Returns a non-administrative property value associated with this MappedTestObject. |
com.rational.test.ft.object.map.MappedTestObjectProperty |
getPropertyData(java.lang.String property)
Returns a non-administrative property+value+weight associated with this MappedTestObject. |
java.util.Enumeration |
getPropertyEnumeration()
Returns an enumeration object that returns a MappedTestObjectProperty instance for each property
associated with this MappedTestObject. |
java.lang.String[] |
getPropertyNames()
Returns the current list of recognition properties. |
int |
getPropertyWeight(java.lang.String property)
Returns a property weight associated with this MappedTestObject. |
java.lang.String |
getProxyClassName()
Returns the proxy class name administrative property. |
java.lang.String |
getRole()
Returns the role administrative property. |
java.lang.String |
getSimpleDescription()
Returns the getDescriptiveName() if the name is not null;
otherwise, the getRole() is returned. |
java.lang.String |
getSimpleName()
Returns the simple name administrative property. |
java.lang.String |
getTestObjectClassName()
Returns the TestObject interface class name administrative property. |
com.rational.test.ft.object.map.IMappedTestObject |
getTopParent()
Returns the topmost parent for an object. |
boolean |
hasProperty(java.lang.String property)
Returns true if the specified property is available
in the associated property set. |
boolean |
isArtificialProperty(java.lang.String propertyName)
Returns true if the property name corresponds to an
extended property, that is, a property not defined by the underlying domain. |
boolean |
isDescriptionObject()
|
boolean |
isIgnoreOwner()
This method returns whether an owner found in the SUT is ignored or not. |
boolean |
isNew()
Returns the state of the associated test object. |
boolean |
isPersistentProperty(java.lang.String propertyName)
Returns true if the property name corresponds to a
property that should be persisted, for example, a property in a verification-point Object recognition
property cache. |
boolean |
isUsed()
This method returns the referrence status of the associated test object. |
void |
removeChild(com.rational.test.ft.object.map.IMappedTestObject child)
Deletes the specified child from this nodes list of child objects. |
void |
removeOwned(com.rational.test.ft.object.map.IMappedTestObject owned)
Deletes the specified owned child from this nodes list of owned objects. |
void |
removeProperty(java.lang.String property)
Removes the specified property from the associated property set. |
void |
setClassName(java.lang.Object className)
Defines the required class name recognition property. |
void |
setDescriptionObject(boolean isDescriptionObject)
|
void |
setDescriptiveName(java.lang.String descriptiveName)
Defines the descriptive name administrative property. |
void |
setDomainName(java.lang.String domainName)
Defines the domain administrative property. |
void |
setId(java.lang.String id)
Associates a map-relative unique identifier with this MappedTestObject. |
void |
setIgnoreOwner(boolean ignoreOwner)
Set the flag to ignore any owner for this object in the SUT. |
void |
setMapProperties(com.rational.test.ft.object.map.IObjectMapPropertySet propSet)
|
void |
setNameInScript(java.lang.String nameInScript)
Define the test object name used to reference this test object in the executing script. |
void |
setNew(boolean state)
Updates the state of the associated test object. |
void |
setOwner(com.rational.test.ft.object.map.IMappedTestObject owner)
Sets a reference to the owner object. |
void |
setParent(com.rational.test.ft.object.map.IMappedTestObject parent)
Sets a reference to the parent object. |
void |
setProperty(com.rational.test.ft.object.map.MappedTestObjectProperty property)
Adds a property to the set of properties associated with this test object. |
void |
setProperty(java.lang.String property,
boolean value,
int weight)
This method defines a non-administrative property. |
void |
setProperty(java.lang.String property,
byte value,
int weight)
Defines a byte-valued non-administrative property. |
void |
setProperty(java.lang.String property,
char value,
int weight)
Defines a character-valued non-administrative property. |
void |
setProperty(java.lang.String property,
double value,
int weight)
Defines a double-valued non-administrative property. |
void |
setProperty(java.lang.String property,
float value,
int weight)
Defines a float-valued non-administrative property. |
void |
setProperty(java.lang.String property,
int value,
int weight)
Defines an integer-valued non-administrative property. |
void |
setProperty(java.lang.String property,
long value,
int weight)
Defines a long-valued non-administrative property. |
void |
setProperty(java.lang.String property,
java.lang.Object value,
int weight)
Defines a non-administrative property associated with this MappedTestObject. |
void |
setProperty(java.lang.String property,
short value,
int weight)
Defines a short-valued non-administrative property. |
void |
setProxyClassName(java.lang.String proxy)
Defines the proxy class name name administrative property. |
void |
setRole(java.lang.String role)
Defines the role administrative property. |
void |
setSimpleName(java.lang.String simpleName)
Defines the simple name administrative property. |
void |
setTestObjectClassName(java.lang.String testObjectClassName)
Defines the test object interface class name administrative property. |
void |
setUsed(boolean used)
This method updates the referrence status of the associated test object. |
java.lang.String |
toString()
|
void |
updateChildOrder(com.rational.test.ft.object.map.IMappedTestObject[] orderedChildren)
Update the order of the children associated with this mapped test object. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static com.rational.test.ft.util.FtDebug debug
| Constructor Detail |
|---|
public MappedTestObject()
public MappedTestObject(com.rational.test.ft.object.map.IMappedTestObject mto)
public MappedTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mto,
boolean saveReferenceToSpyMto)
| Method Detail |
|---|
public void setMapProperties(com.rational.test.ft.object.map.IObjectMapPropertySet propSet)
setMapProperties in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.IObjectMapPropertySet getMapProperties()
getMapProperties in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getId()
getId in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setId(java.lang.String id)
MappedTestObject. Note
that no MappedTestObject can be an element in more than one object map; this object therefore
has only this one unique identifier.
setId in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void clearId()
clearId in interface com.rational.test.ft.object.map.IMappedTestObjectpublic boolean isNew()
isNew in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setNew(boolean state)
setNew in interface com.rational.test.ft.object.map.IMappedTestObjectstate - The updated state of this MappedTestObject.public void setDescriptionObject(boolean isDescriptionObject)
public boolean isDescriptionObject()
public java.lang.String getSimpleDescription()
getDescriptiveName() if the name is not null;
otherwise, the getRole() is returned.
getSimpleDescription in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getDescriptiveName()
getDescriptiveName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setDescriptiveName(java.lang.String descriptiveName)
setDescriptiveName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getSimpleName()
getSimpleName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setSimpleName(java.lang.String simpleName)
setSimpleName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getRole()
getRole in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setRole(java.lang.String role)
setRole in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getNameInScript()
null is returned.
getNameInScript in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setNameInScript(java.lang.String nameInScript)
setNameInScript in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.IMappedTestObject getParent()
getParent in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setParent(com.rational.test.ft.object.map.IMappedTestObject parent)
setParent in interface com.rational.test.ft.object.map.IMappedTestObjectpublic int getChildCount(boolean allChildren)
MappedTestObject. If allChildren is requested, a deep
count is performed, meaning that immediate children, grandchildren, and so on are counted.
getChildCount in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.IMappedTestObject[] getChildren()
MappedTestObject. The list of children is updated when the
parent relationship is established with the child.
getChildren in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void updateChildOrder(com.rational.test.ft.object.map.IMappedTestObject[] orderedChildren)
public void removeChild(com.rational.test.ft.object.map.IMappedTestObject child)
removeChild in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.IMappedTestObject getOwner()
getOwner in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setOwner(com.rational.test.ft.object.map.IMappedTestObject owner)
setOwner in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.IMappedTestObject[] getOwned()
MappedTestObject. The list of owned children is updated when the
owner relationship is established with the owned child.
getOwned in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void removeOwned(com.rational.test.ft.object.map.IMappedTestObject owned)
removeOwned in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setIgnoreOwner(boolean ignoreOwner)
true
is that if the node has an owner it will be removed.
setIgnoreOwner in interface com.rational.test.ft.object.map.IMappedTestObjectignoreOwner - public boolean isIgnoreOwner()
false if the object has a parent object.
isIgnoreOwner in interface com.rational.test.ft.object.map.IMappedTestObjecttrue if the top level object should ignore any owner defined
in the SUT.public java.lang.String getDomainName()
getDomainName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setDomainName(java.lang.String domainName)
setDomainName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getProxyClassName()
getProxyClassName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setProxyClassName(java.lang.String proxy)
setProxyClassName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String getTestObjectClassName()
getTestObjectClassName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setTestObjectClassName(java.lang.String testObjectClassName)
setTestObjectClassName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.Object getClassName()
Object so that the class can be converted to a
regular expression and not limited to just a String value.
getClassName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setClassName(java.lang.Object className)
setClassName in interface com.rational.test.ft.object.map.IMappedTestObjectpublic boolean hasProperty(java.lang.String property)
true if the specified property is available
in the associated property set.
hasProperty in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.MappedTestObjectProperty getPropertyData(java.lang.String property)
MappedTestObject.
getPropertyData in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.Object getProperty(java.lang.String property)
MappedTestObject.
getProperty in interface com.rational.test.ft.object.map.IMappedTestObjectpublic int getPropertyWeight(java.lang.String property)
MappedTestObject. The property weight is a measure of
importance associated with non-administrative properties.
The property weight is a value that is greater than or equal to zero (not
important) and less than or equal to one hundred (most important).
getPropertyWeight in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setProperty(com.rational.test.ft.object.map.MappedTestObjectProperty property)
public void setProperty(java.lang.String property,
java.lang.Object value,
int weight)
MappedTestObject.
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
int value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
long value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
short value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
byte value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
float value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
double value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
char value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObject
public void setProperty(java.lang.String property,
boolean value,
int weight)
setProperty in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void removeProperty(java.lang.String property)
removeProperty in interface com.rational.test.ft.object.map.IMappedTestObjectpublic com.rational.test.ft.object.map.IMappedTestObject getTopParent()
getTopParent in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.lang.String[] getPropertyNames()
getPropertyNames in interface com.rational.test.ft.object.map.IMappedTestObjectpublic java.util.Enumeration getPropertyEnumeration()
MappedTestObjectProperty instance for each property
associated with this MappedTestObject.
getPropertyEnumeration in interface com.rational.test.ft.object.map.IMappedTestObjectpublic boolean isArtificialProperty(java.lang.String propertyName)
true if the property name corresponds to an
extended property, that is, a property not defined by the underlying domain.
All artifical properties use a '#' character as the first character
in the property name. Non-administrative properties should not use
this character as the first character.
isArtificialProperty in interface com.rational.test.ft.object.map.IMappedTestObjectpublic boolean isPersistentProperty(java.lang.String propertyName)
true if the property name corresponds to a
property that should be persisted, for example, a property in a verification-point Object recognition
property cache. By convention, transient
properties begin with a double pound sign (##) sequence so that
they can be identified easily.
isPersistentProperty in interface com.rational.test.ft.object.map.IMappedTestObjectpublic boolean isUsed()
isUsed in interface com.rational.test.ft.object.map.IMappedTestObjectpublic void setUsed(boolean used)
setUsed in interface com.rational.test.ft.object.map.IMappedTestObjectstate - The updated reference status of this mapped test object.public java.lang.String toString()
toString in class java.lang.Objectpublic void debugDisplay()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||