com.testarchitect

Interface Project

All Superinterfaces:

Entity

public interface Project
extends Entity

This interface represents a TestArchitect project. The methods in this class are used as the starting point to access folders, test modules, test cases, etc.

Method Summary

Modifier and Type	Method and Description
int	exportFromId(String sID, String destinationFile, String outputType, boolean overwrite) Export a specific project item, identified by its TestArchitect ID, to a file.
int	exportFromId(String sID, String destinationFile, String outputType, boolean overwrite, boolean includePictureChecks) Export a specific project item, identified by its TestArchitect ID, to a file.
int	exportFromPath(String sourcePath, String destinationFile, String outputType, boolean overwrite) Export a specific project item, identified by its TA path, to a file.
int	exportFromPath(String sourcePath, String destinationFile, String outputType, boolean overwrite, boolean includePictureChecks) Export a specific project item, identified by its TA path, to a file.
Action	getAction(String treePath) Returns the desired Action object based on the given tree path.
ActionFolder	getActionFolder(String treePath) Returns the desired ActionFolder object with the given relative tree path.
Collection	getActionFolders(boolean isRecursive) Returns recursively a collection of action folders in the current project.
Collection	getActions(boolean isRecursive) Returns recursively a collection of high-level actions in the current project.
String	getCreatedBy() Returns the name of the user who has created the current project.
String	getCreationDate() Returns the date of project creation.
Dataset	getDataset(String treePath) Returns the desired Dataset object with the given relative tree path.
DatasetFolder	getDatasetFolder(String treePath) Returns the desired DatasetFolder object with the given relative tree path.
Collection	getDatasetFolders(boolean isRecursive) Returns recursively a collection of dataset folders in the current project.
Collection	getDatasets(boolean isRecursive) Returns recursively a collection of datasets in the current project.
String	getDescription() Returns the value of the Description field in the current project.
Collection	getInterfaceEntities(String treePath) Returns the desired InterfaceEntity object with the given relative tree path.
String[]	getLastProblems() This function serves for error handling purpose.
Collection	getLocalResults() Returns a collection of all local results. Local results are results that have not been stored into the repository.
String	getNotes() Returns the value of the Notes field in the current project.
PictureCheck	getPictureCheck(String treePath) Returns the desired picture check with the given relative tree path.
Collection	getPictureChecks(boolean isRecursive) Returns recursively a collection of picture checks in the current
Result	getResult(String treePath) Return the desired Result object with the given relative tree path.
ResultFolder	getResultFolder(String treePath) Returns the desired ResultFolder object with the given relative tree path.
Collection	getResultFolders(boolean isRecursive) Returns recursively a collection of test result folders in the current project.
Collection	getResults(boolean isRecursive) Returns recursively a collection of test result status in the current project.
String	getTestedApplication() Returns the value of the Tested application field in the current project.
TestFolder	getTestFolder(String treePath) Returns the desired TestFolder object with the given relative tree path.
Collection	getTestFolders(boolean isRecursive) Returns recursively a collection of test module folders in the current project.
TestModule	getTestModule(String treePath) Returns the desired TestModule object with the given relative tree path.
Collection	getTestModules(boolean isRecursive) Returns recursively a collection of test modules in the current project.
TestSuite	getTestSuite(String treePath) Returns the desired TestSuite object with the given relative tree path.
TestSuiteFolder	getTestSuiteFolder(String treePath) Returns the desired TestSuiteFolder object with the given relative tree path.
Collection	getTestSuiteFolders(boolean isRecursive) Returns recursively a collection of test suite folders in the current project.
Collection	getTestSuites(boolean isRecursive) Returns recursively a collection of test suites in the current project.
int	importToId(String sourceFilePath, String sID, boolean overwrite) Import a project item from a file to a project location identified by TestArchitect ID.
int	importToId(String sourceFilePath, String sID, boolean overwrite, boolean includePictureChecks) Import a project item from a file to a project location identified by TestArchitect ID.
int	importToPath(String source, String destination, boolean overwrite) Import a project item from a file to a project location identified by TA path.
int	importToPath(String source, String destination, boolean overwrite, boolean includePictureChecks) Import a project item from a file to a project location identified by TA path.

Methods inherited from interface com.testarchitect.Entity

getFieldValue, getName

Method Detail

getTestFolders

Collection getTestFolders(boolean isRecursive)

Returns recursively a collection of test module folders in the current project.

Parameters:

isRecursive - Gets the test module folders recursively at all levels.

false: Gets the test module folders at the top level only.

Returns:

a collection of folders, as TestFolder objects

getTestFolder

TestFolder getTestFolder(String treePath)

Returns the desired TestFolder object with the given relative tree path.

Parameters:

treePath - String with a path within the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a TestFolder object, or null

getTestModules

Collection getTestModules(boolean isRecursive)

Returns recursively a collection of test modules in the current project.

Parameters:

isRecursive - true: Gets the test modules recursively at all levels.
false: Gets the test modules at the top level only.

Returns:

a collection of TestModule objects

getTestModule

TestModule getTestModule(String treePath)

Returns the desired TestModule object with the given relative tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a TestModule object, or null

getResultFolders

Collection getResultFolders(boolean isRecursive)

Returns recursively a collection of test result folders in the current project.

Parameters:

isRecursive - true: Gets the result folders recursively at all levels.
false: Gets the result folders at the top level only.

Returns:

a collection of ResultFolder objects

getResultFolder

ResultFolder getResultFolder(String treePath)

Returns the desired ResultFolder object with the given relative tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a ResultFolder object, or null

getResults

Collection getResults(boolean isRecursive)

Returns recursively a collection of test result status in the current project.

Parameters:

isRecursive - true: Gets the test results at all levels.
false: Gets the test results at the top level only.

Returns:

a collection of Result objects

getResult

Result getResult(String treePath)

Return the desired Result object with the given relative tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a Result object, or null

getLocalResults

Collection getLocalResults()

Returns a collection of all local results.
Local results are results that have not been stored into the repository.

Returns:

a collection of Result instances

getDescription

String getDescription()

Returns the value of the Description field in the current project.

Returns:

A string contains the value of the Description field.

getCreationDate

String getCreationDate()

Returns the date of project creation.

Returns:

A string contains the value of the date of project creation.

getCreatedBy

String getCreatedBy()

Returns the name of the user who has created the current project.

Returns:

A string with the user name.

getTestedApplication

String getTestedApplication()

Returns the value of the Tested application field in the current project.

Returns:

A string contains the value of the Tested application field.

getNotes

String getNotes()

Returns the value of the Notes field in the current project.

Returns:

A string contains the value of the Notes field.

getLastProblems

String[] getLastProblems()

This function serves for error handling purpose.

Returns:

An array of string contains all the problems.

exportFromPath

int exportFromPath(String sourcePath,
                   String destinationFile,
                   String outputType,
                   boolean overwrite,
                   boolean includePictureChecks)

Export a specific project item, identified by its TA path, to a file.

Parameters:

sourcePath - Location (TA path) of the item to be exported. Value must begin with a "/" character, and provide a full (non-case sensitive) TA explorer path, including the project name and project item subtree.

destinationFile - Location into which the exported file is to be placed. If the path includes a file name, this name is assigned to the export file; if not, a name is generated based on the name of the item being exported.

outputType - Type of file to export to. Current available options are "html", "zip" (TA's zip format), "csv" (comma separated values), "txt" (tab separated text) and "taresult" (TA's compressed format).

overwrite - true, overwrite existing item, if any; false, do not overwrite.

includePictureChecks - true, exporting test module contains Local Picture Checks; false, do not include Local Picture Checks (Only for 'Zip')

Returns:

1: Export completed successfully / Any other value: export failed.

exportFromPath

int exportFromPath(String sourcePath,
                   String destinationFile,
                   String outputType,
                   boolean overwrite)

Export a specific project item, identified by its TA path, to a file.

Parameters:

sourcePath - Location (TA path) of the item to be exported. Value must begin with a "/" character, and provide a full (non-case sensitive) TA explorer path, including the project name and project item subtree.

destinationFile - Location into which the exported file is to be placed. If the path includes a file name, this name is assigned to the export file; if not, a name is generated based on the name of the item being exported.

outputType - Type of file to export to. Current available options are "html", "zip" (TA's zip format), "csv" (comma separated values), "txt" (tab separated text) and "taresult" (TA's compressed format).

overwrite - true, overwrite existing item, if any; false, do not overwrite.

Returns:

1: Export completed successfully / Any other value: export failed.

exportFromId

int exportFromId(String sID,
                 String destinationFile,
                 String outputType,
                 boolean overwrite,
                 boolean includePictureChecks)

Export a specific project item, identified by its TestArchitect ID, to a file.

Parameters:

sID - ID of the item to be exported.

destinationFile - File path for the exported file. If the path includes a file name, this name is assigned to the export file; if not, a name is generated based on the name of the item being exported.

outputType - Type of file to export to. Current available options are "html", "zip" (TA's zip format), "csv" (comma separated values), "txt" (tab separated text) and "taresult" (TA's compressed format).

overwrite - true: overwrite existing item, if any. / false: do not overwrite.

includePictureChecks - true, exporting test module contains Local Picture Checks; false, do not include Local Picture Checks (Only for 'Zip')

Returns:

1: Export completed successfully / Any other value: export failed.

exportFromId

int exportFromId(String sID,
                 String destinationFile,
                 String outputType,
                 boolean overwrite)

Export a specific project item, identified by its TestArchitect ID, to a file.

Parameters:

sID - ID of the item to be exported.

destinationFile - File path for the exported file. If the path includes a file name, this name is assigned to the export file; if not, a name is generated based on the name of the item being exported.

outputType - Type of file to export to. Current available options are "html", "zip" (TA's zip format), "csv" (comma separated values), "txt" (tab separated text) and "taresult" (TA's compressed format).

overwrite - true: overwrite existing item, if any. / false: do not overwrite.

Returns:

1: Export completed successfully / Any other value: export failed.

importToId

int importToId(String sourceFilePath,
               String sID,
               boolean overwrite,
               boolean includePictureChecks)

Import a project item from a file to a project location identified by TestArchitect ID.

Parameters:

sourceFilePath - Location (file path) of the file containing the item to import.

sID - ID of the project item or folder into which the item is to be imported

overwrite - true: overwrite existing item, if any. / false: do not overwrite

includePictureChecks - true, importing test module contains Local Picture Checks; false, do not include Local Picture Checks (Only for 'Zip')

Returns:

1: import completed successfully / Any other value: import failed.

importToId

int importToId(String sourceFilePath,
               String sID,
               boolean overwrite)

Import a project item from a file to a project location identified by TestArchitect ID.

Parameters:

sourceFilePath - Location (file path) of the file containing the item to import.

sID - ID of the project item or folder into which the item is to be imported

overwrite - true: overwrite existing item, if any. / false: do not overwrite

Returns:

1: import completed successfully / Any other value: import failed.

importToPath

int importToPath(String source,
                 String destination,
                 boolean overwrite,
                 boolean includePictureChecks)

Import a project item from a file to a project location identified by TA path.

Parameters:

source - Location (file path) of the file containing the item to import.

destination - Location (TA path) into which the item is to be imported. Value must begin with a "/" character, and provide a full (non-case sensitive) TA explorer path, including the project name and project item subtree.

overwrite - true: overwrite existing item, if any. / false: do not overwrite.

includePictureChecks - true, importing test module contains Local Picture Checks; false, do not include Local Picture Checks (Only for 'Zip')

Returns:

1: import completed successfully / Any other value: import failed.

importToPath

int importToPath(String source,
                 String destination,
                 boolean overwrite)

Import a project item from a file to a project location identified by TA path.

Parameters:

source - Location (file path) of the file containing the item to import.

destination - Location (TA path) into which the item is to be imported. Value must begin with a "/" character, and provide a full (non-case sensitive) TA explorer path, including the project name and project item subtree.

overwrite - true: overwrite existing item, if any. / false: do not overwrite.

Returns:

1: import completed successfully / Any other value: import failed.

getAction

Action getAction(String treePath)

Returns the desired Action object based on the given tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

an Action object, or null

getActions

Collection getActions(boolean isRecursive)

Returns recursively a collection of high-level actions in the current project.

Parameters:

isRecursive - true: Gets the high-level actions recursively at all levels.
false: Gets the high-level actions at the top level only.

Returns:

a collection of Action objects

getTestSuite

TestSuite getTestSuite(String treePath)

Returns the desired TestSuite object with the given relative tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a TestSuite object, or null

getTestSuites

Collection getTestSuites(boolean isRecursive)

Returns recursively a collection of test suites in the current project.

Parameters:

isRecursive - true: Gets the test suites recursively at all levels.
false: Gets the test suites at the top level only.

Returns:

a collection of TestSuite objects

getDataset

Dataset getDataset(String treePath)

Returns the desired Dataset object with the given relative tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a Dataset object, or null

getDatasets

Collection getDatasets(boolean isRecursive)

Returns recursively a collection of datasets in the current project.

Parameters:

isRecursive - true: Gets the datasets recursively at all levels.
false: Gets the datasets at the top level only.

Returns:

a collection of Dataset objects

getActionFolders

Collection getActionFolders(boolean isRecursive)

Returns recursively a collection of action folders in the current project.

Parameters:

isRecursive - Gets the action folders recursively at all levels.
false: Gets the action folders at the top level only.

Returns:

a collection of folders, as ActionFolder objects

getActionFolder

ActionFolder getActionFolder(String treePath)

Returns the desired ActionFolder object with the given relative tree path.

Parameters:

treePath - String with a path within the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a ActionFolder object, or null

getDatasetFolders

Collection getDatasetFolders(boolean isRecursive)

Returns recursively a collection of dataset folders in the current project.

Parameters:

isRecursive - Gets the dataset folders recursively at all levels.
false: Gets the dataset folders at the top level only.

Returns:

a collection of folders, as DatasetFolder objects

getDatasetFolder

DatasetFolder getDatasetFolder(String treePath)

Returns the desired DatasetFolder object with the given relative tree path.

Parameters:

treePath - String with a path within the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a DatasetFolder object, or null

getTestSuiteFolders

Collection getTestSuiteFolders(boolean isRecursive)

Returns recursively a collection of test suite folders in the current project.

Parameters:

isRecursive - Gets the test suite folders recursively at all levels.
false: Gets the test suite folders at the top level only.

Returns:

a collection of folders, as TestSuiteFolder objects

getTestSuiteFolder

TestSuiteFolder getTestSuiteFolder(String treePath)

Returns the desired TestSuiteFolder object with the given relative tree path.

Parameters:

treePath - String with a path within the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a TestSuiteFolder object, or null

getInterfaceEntities

Collection getInterfaceEntities(String treePath)

Returns the desired InterfaceEntity object with the given relative tree path.

Parameters:

treePath - String with a path within the tree, starting with forward slash ( / ), and the items in the path are also separated by forward slashes ( / ).

Returns:

a InterfaceEntity object, or null

getPictureCheck

PictureCheck getPictureCheck(String treePath)

Returns the desired picture check with the given relative tree path.

Parameters:

treePath - String with a path in the tree, starting with forward slash (/), and the items in the path are also separated by forward slashes (/).

Returns:

a PictureCheck object, or null

getPictureChecks

Collection getPictureChecks(boolean isRecursive)

Returns recursively a collection of picture checks in the current

Parameters:

isRecursive - true: Gets the picture checks recursively at all levels.
false: Gets the picture checks at the top level only.

Returns:

a collection of PictureCheck objects.