com.rational.test.ft.vp
Interface ITestData

All Known Subinterfaces:

ITestDataList, ITestDataMenu, ITestDataProperties, ITestDataTable, ITestDataText, ITestDataTree, ITestDataTreeAttributes

public interface ITestData

Provides base-level support for verification-point data returned from a proxy object. The top level of this data is referred to as metadata in the verification point documentation and in the GUI. Metadata properties are used to manage the associated data. The Data property provides access to the interesting data.

Since:

RFT1.0

Method Summary

java.lang.Object	getData() Returns the real data associated with this verification point.
java.lang.String	getDataType() Returns the type name used internally to update the data associated with this verification-point data.
java.lang.String	getDescription() Returns the description displayed to the user that describes this verification-point data.
java.lang.String	getName() Returns the name associated with this verification-point script.
java.lang.Object	getProperty(java.lang.String propertyName) Returns a specific property set, that is, a value for this verification point data.
java.lang.String[]	getPropertyKeys() Returns an array of property names.
java.lang.String	getType() Deprecated. As of version RFT1.1
void	setData(java.lang.Object data) Sets the real data associated with this verification point.
void	setDataType(java.lang.String type) Sets the type name used internally to update the data associated with this verification-point data.
void	setDescription(java.lang.String description) Sets the description displayed to the user that describes this verification-point data.
void	setName(java.lang.String name) Sets the name of this verification-point data.
void	setProperty(java.lang.String propertyName, java.lang.Object value) Sets a specific property for this verification-point data.
void	setType(java.lang.String type) Deprecated. As of version RFT1.1

Method Detail

getData

java.lang.Object getData()

Returns the real data associated with this verification point.

Since:

RFT1.0

See Also:

setData(Object)

setData

void setData(java.lang.Object data)

Sets the real data associated with this verification point.

Parameters:

data - The real data associated with this verification point

Since:

RFT1.0

See Also:

getData()

getName

java.lang.String getName()

Returns the name associated with this verification-point script. The name can be adjusted as necessary during data persistence.

Since:

RFT1.0

See Also:

setName(String)

setName

void setName(java.lang.String name)

Sets the name of this verification-point data. This name must be unique relative to the associated script; it can be adjusted as necessary during data persistence.

Parameters:

name - the unique name of this test data, relative to the script

Since:

RFT1.0

See Also:

getName()

getDescription

java.lang.String getDescription()

Returns the description displayed to the user that describes this verification-point data.

Since:

RFT1.0

See Also:

setDescription(String)

setDescription

void setDescription(java.lang.String description)

Sets the description displayed to the user that describes this verification-point data.

Parameters:

description - description of this test data

Since:

RFT1.0

See Also:

getDescription()

getType

java.lang.String getType()

Deprecated. As of version RFT1.1

Returns the type name used internally to update the data associated with this verification-point data.

Since:

RFT1.0

See Also:

setType(String)

getDataType

java.lang.String getDataType()

Returns the type name used internally to update the data associated with this verification-point data.

Since:

RFT1.0

See Also:

setDataType(String)

setType

void setType(java.lang.String type)

Deprecated. As of version RFT1.1

Sets the type name used internally to update the data associated with this verification-point data.

Parameters:

description - the internal type name of this test data

Since:

RFT1.0

See Also:

getType()

setDataType

void setDataType(java.lang.String type)

Sets the type name used internally to update the data associated with this verification-point data.

Parameters:

description - the internal type name of this test data

Since:

RFT1.0

See Also:

getDataType()

getProperty

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

Returns a specific property set, that is, a value for this verification point data. The exception PropertyNotFoundException is thrown if the requested property does not exist.

Parameters:

propertyName - the name of the property being located

Returns:

The value of the property

Since:

RFT1.0

See Also:

setProperty(String,Object)

setProperty

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

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

Parameters:

propertyName - the name of the property being defined

value - the value of the property

Since:

RFT1.0

See Also:

getProperty(String)

getPropertyKeys

java.lang.String[] getPropertyKeys()

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

Since:

RFT1.0

See Also:

getProperty(String), setProperty(String,Object)