com.rational.test.ft.vp

Interface IFtVerificationPointImage

public interface IFtVerificationPointImage

Represents the core abstraction for static and dynamic verification-point data. At this level of verification-point data abstraction, properties are administrative. They are used to manage auxiliary data and to locate associated objects in the software under test.

Since:

RFT1.0

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(java.lang.Object right) Compares the supplied data to this particular data object.
ITestObjectDescriptor[]	find(IScriptDefinition scriptDef, ObjectMap objectMap, TestObject anchor) Locates and returns objects in the software under test that are relative to this verification point.
ITestObjectDescriptor	findFirst() Locates and returns the first unmasked object in the verification-point data.
IFtVerificationPointImage	getCurrentImage(IScriptDefinition scriptDef, ObjectMap objectMap, TestObject anchor) Makes a copy of the existing verification-point object information and reaches out to the objects under test to get the active ITestData.
ITestData	getCurrentImage(ITestObjectDescriptor target, IScriptDefinition scriptDef, ObjectMap objectMap, TestObject anchor) Returns the active ITestData object for this verification point.
ITestData	getImage(ITestObjectDescriptor target) Returns the ITestData object for this verification point.
java.lang.Object	getProperty(java.lang.String propertyName) Returns a specific property set for this verification point.
java.lang.String[]	getPropertyKeys() Returns an array of property names.
void	removeProperty(java.lang.String propertyName) Removes a specific property for this verification point.
void	setImage(ITestObjectDescriptor target, ITestData data) Sets the ITestData object for this verification point.
void	setProperty(java.lang.String propertyName, java.lang.Object value) Sets a specific property for this verification point.

Method Detail

find

ITestObjectDescriptor[] find(IScriptDefinition scriptDef,
                           ObjectMap objectMap,
                           TestObject anchor)

Locates and returns objects in the software under test that are relative to this verification point. If the objects cannot be located, an ObjectNotFoundException is thrown. Only active objects are returned; objects are ignored if they lack relevant test data or have been disabled.

Since:

RFT1.0

findFirst

ITestObjectDescriptor findFirst()

Locates and returns the first unmasked object in the verification-point data.

Since:

RFT1.0

compare

int compare(java.lang.Object right)

Compares the supplied data to this particular data object. The result is a value in the range of 0 to 100. A value of 0 means that the data compares well, and a value of 100 means that the data compares very well. A value of 0 to 99 implies not equal, while a value of 100 implies equality.

Since:

RFT1.0

getCurrentImage

IFtVerificationPointImage getCurrentImage(IScriptDefinition scriptDef,
                                        ObjectMap objectMap,
                                        TestObject anchor)

Makes a copy of the existing verification-point object information and reaches out to the objects under test to get the active ITestData. The verification-point type associated with the resulting object is always actual and is persisted as the actual data if the static store method is called.

Returns:

The actual verification-point data

Since:

RFT1.0

getImage

ITestData getImage(ITestObjectDescriptor target)

Returns the ITestData object for this verification point.

Parameters:

target - the object in the software under test for which data is gathered

Since:

RFT1.0

getCurrentImage

ITestData getCurrentImage(ITestObjectDescriptor target,
                        IScriptDefinition scriptDef,
                        ObjectMap objectMap,
                        TestObject anchor)

Returns the active ITestData object for this verification point. Only one data property is associated with the verification-point data.

Returns:

The actual ITestData for the specified object under evaluation

Since:

RFT1.0

setImage

void setImage(ITestObjectDescriptor target,
            ITestData data)

Sets the ITestData object for this verification point. Only one data property is associated with the verification-point data.

Parameters:

data - the ITestData object to use for this verification point

Since:

RFT1.0

getProperty

java.lang.Object getProperty(java.lang.String propertyName)

Returns a specific property set for this verification point. The exception java.util.NoSuchElementException is thrown if the requested property does not exist. The properties in the property set are administrative properties for finding an object in the software under test and for managing auxiliary data.

Parameters:

propertyName - the name of the property being located

Returns:

The value of the property

Since:

RFT1.0

See Also:

setProperty(String,Object), getPropertyKeys()

setProperty

void setProperty(java.lang.String propertyName,
               java.lang.Object value)

Sets a specific property for this verification point. The property value must be a registered data type so that it can be properly persisted and compared. Use of a leading # character in the property name is reserved by the testing environment and should not be used by specific IFtVerificationPointData implementations.

Parameters:

propertyName - the name of the property being defined

value - the value of the property

Since:

RFT1.0

See Also:

getProperty(String)

removeProperty

void removeProperty(java.lang.String propertyName)

Removes a specific property for this verification point.

Parameters:

propertyName - the name of the property being deleted.

See Also:

getProperty(String), setProperty(String,Object)

getPropertyKeys

java.lang.String[] getPropertyKeys()

Returns an array of property names. This array is an inclusive list of all property names, including internally set names. The internally defined properties begin with a # character; you should not directly manipulate them.

Since:

RFT1.0

See Also:

getProperty(String), setProperty(String,Object)