com.rational.test.ft.script
Interface IDatastore

All Known Subinterfaces:

ITestProject

public interface IDatastore

Provides information concerning a single-test project (formerly called a project) on a particular host system.

Since:

RFT1.0

Method Summary

java.util.Enumeration	getDatapoolScripts(java.lang.String dpName) Provides an enumeration of scripts associated with the specified datapool in the associated test project.
java.lang.String	getDefaultMapName() Provides access to the default test-object map name associated with this test project.
int	getMajorVersionNumber() Provides access to the major version for the project.
int	getMinorVersionNumber() Provides access to the minor version for the project.
java.util.Enumeration	getObjectMapScripts(java.lang.String mapName) Provides an enumeration of scripts associated with the specified map in the associated test project.
java.lang.String	getProjectName() Provides access to the test-management project name associated with this test project.
java.lang.String	getProjectPath() Provides access to the test-management project path associated with this test project.
java.lang.String	getProjectSubType() Provides access to the sub-type for the project.
java.util.Enumeration	getScripts() Provides an enumeration of the full script names available in the current associated test project.
java.util.Enumeration	getScripts(java.lang.String mapName) Deprecated. As of RFT2.0. Please use getObjectMapScripts(String)
java.util.Enumeration	getSharedDatapools() Provides an enumeration of project-relative datapool file names available in the associated test project.
java.util.Enumeration	getSharedMaps() Provides an enumeration of project-relative map file names available in the associated test project.
java.util.Enumeration	getSimplifiedScriptVisuals() Provides the enumeration of Project related application visuals for the simplified script
java.util.Enumeration	getSimplifiedScriptVPs()
java.util.Enumeration	getTemplates() Provides an enumeration of the project-relative template file names available in the associated test project.

Method Detail

getMajorVersionNumber

int getMajorVersionNumber()

Provides access to the major version for the project. Variations in this number imply significant changes to the project structure. If this number changes, a conversion of the project to the newer layout is implied.

Returns:

The major version number for the project

Since:

RFT1.1

getMinorVersionNumber

int getMinorVersionNumber()

Provides access to the minor version for the project. Variations in this number imply minor changes to the project structure or contents. If this number changes, a conversion of the project is not necessary and the project is completely forward compatible.

Returns:

The minor version number for the project

Since:

RFT1.1

getProjectName

java.lang.String getProjectName()

Provides access to the test-management project name associated with this test project. Log files and cross-platform script actions are generated relative to the project.

Returns:

The test-management project name associated with this test project

Since:

RFT1.0

getProjectPath

java.lang.String getProjectPath()

Provides access to the test-management project path associated with this test project. Log files and cross-platform script actions are generated relative to the project.

Returns:

The test-management project path associated with this test project

Since:

RFT1.0

getDefaultMapName

java.lang.String getDefaultMapName()

Provides access to the default test-object map name associated with this test project. If null, the private object maps are used by default.

Returns:

The object map name associated with this test project

Since:

RFT1.0

getScripts

java.util.Enumeration getScripts()

Provides an enumeration of the full script names available in the current associated test project. The values returned are String values that represent the full name of the script class. For example, company.project.Script42 might be returned if such a script exists in the project.

Returns:

An enumeration of full script names available in the current associated-test project

Since:

RFT1.0

getScripts

java.util.Enumeration getScripts(java.lang.String mapName)

Deprecated. As of RFT2.0. Please use getObjectMapScripts(String)

Provides an enumeration of scripts associated with the specified map in the associated test project. The values returned are String values that represent the full name of the script class. For example, company.project.Script42 might be returned if such a script exists in the project.

The mapName is the project-relative file name of the map, including any file suffix and path separators. For example, maps/MyApplication.rftmap might be returned if such a shared map exists in the project.

Parameters:

mapName - the project-relative file name of the map, including any file suffix and path separators

Returns:

An enumeration of full script names available in the current associated test project that refer to the specified object map

Since:

RFT1.0

See Also:

getObjectMapScripts(String)

getObjectMapScripts

java.util.Enumeration getObjectMapScripts(java.lang.String mapName)

Provides an enumeration of scripts associated with the specified map in the associated test project. The values returned are String values that represent the full name of the script class. For example, company.project.Script42 might be returned if such a script exists in the project.

The mapName is the project-relative file name of the map, including any file suffix and path separators. For example, maps/MyApplication.rftmap might be returned if such a shared map exists in the project.

Parameters:

mapName - the project-relative file name of the map, including any file suffix and path separators

Returns:

An enumeration of full script names available in the current associated test project that refer to the specified object map

Since:

RFT2.0

getDatapoolScripts

java.util.Enumeration getDatapoolScripts(java.lang.String dpName)

Provides an enumeration of scripts associated with the specified datapool in the associated test project. The values returned are String values that represent the full name of the script class. For example, company.project.Script42 might be returned if such a script exists in the project.

The dpName is the project-relative file name of the datapool, including any file suffix and path separators. For example, maps/MyApplication.rftdp might be returned if such a shared datapool exists in the project.

Parameters:

dpName - the project-relative file name of the datapool, including any file suffix and path separators

Returns:

An enumeration of full script names available in the current associated test project that refer to the specified datapool

Since:

RFT2.0

getSharedMaps

java.util.Enumeration getSharedMaps()

Provides an enumeration of project-relative map file names available in the associated test project. The values returned are String values that represent the project-relative map file name. For example, maps/MyApplication.rftmap might be returned if such a shared map exists in the project.

Returns:

An enumeration of project-relative map file names available in the associated test project

Since:

RFT1.0

getSharedDatapools

java.util.Enumeration getSharedDatapools()

Provides an enumeration of project-relative datapool file names available in the associated test project. The values returned are String values that represent the project-relative datapool file name. For example, datapools/MyApplication.rftdp might be returned if such a shared datapool exists in the project.

Returns:

An enumeration of project-relative datapool file names available in the associated test project

Since:

RFT2.0

getTemplates

java.util.Enumeration getTemplates()

Provides an enumeration of the project-relative template file names available in the associated test project. The template files act as extension points to allow user control over script generation and test-object name generation. The values returned from the enumeration are always String values.

Returns:

An enumeration of the project-relative template file names available in the associated test project

Since:

RFT1.0

getProjectSubType

java.lang.String getProjectSubType()

Provides access to the sub-type for the project. This is "java" for a java project and "NET" for a VB project.

Returns:

The project sub-type

Since:

RFT2.0

getSimplifiedScriptVisuals

java.util.Enumeration getSimplifiedScriptVisuals()

Provides the enumeration of Project related application visuals for the simplified script

Returns:

getSimplifiedScriptVPs

java.util.Enumeration getSimplifiedScriptVPs()