OTX-Runtime for Java  
OpenTestSystem.Otx.Runtime.Api.Project.IProject Interface Reference

Contains Packages and settings. More...

Public Member Functions

IProcedure GetMainProcedure ()
 Gets main Procedure of startup Document. More...
 
String GetName ()
 Gets Project name. More...
 
IPackage[] GetPackages ()
 Gets all Packages. More...
 
IPlayerProject GetPlayerProject ()
 Gets PlayerProject. More...
 
IProcedure GetProcedureByName (String fullName)
 Get Procedure base on it's full name. More...
 
IProjectSettings GetProjectSettings ()
 Gets the Project Settings. More...
 
IRuntimeManager GetRuntimeManager ()
 Gets RuntimeManager. More...
 
Map< String, String > GetSettings ()
 Gets the Project Settings. More...
 
ISignature GetSignatureByName (String fullName)
 Gets Signature base on it's full name. More...
 
IDocument GetStartupDocument ()
 Gets startup Document. More...
 
String GetVersion ()
 Gets Project version. More...
 
void SetSettings (Map< String, String > settings)
 Sets the Project Settings. More...
 

Detailed Description

Contains Packages and settings.

Member Function Documentation

◆ GetMainProcedure()

IProcedure OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetMainProcedure ( )

Gets main Procedure of startup Document.

Returns
Main Procedure of startup Document.

◆ GetName()

String OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetName ( )

Gets Project name.

Returns
Project name.

◆ GetPackages()

IPackage [] OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetPackages ( )

Gets all Packages.

Returns
A list of Packages.

◆ GetPlayerProject()

IPlayerProject OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetPlayerProject ( )

Gets PlayerProject.

Returns
A PlayerProject which this Project belongs to.

◆ GetProcedureByName()

IProcedure OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetProcedureByName ( String  fullName)

Get Procedure base on it's full name.

Returns
A Procedure with following full name. If no procedure was found, return null.

◆ GetProjectSettings()

IProjectSettings OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetProjectSettings ( )

Gets the Project Settings.

As an alternative it is possible to handle the settings inside Settings.

Returns
A ProjectSettings which this Project belongs to.

◆ GetRuntimeManager()

IRuntimeManager OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetRuntimeManager ( )

Gets RuntimeManager.

Returns
A RuntimeManager which this Project belongs to.

◆ GetSettings()

Map<String, String> OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetSettings ( )

Gets the Project Settings.

Gets the Project Settings as a map of names and value pairs. The getter returns all settings. The setter sets only the name value pairs in the given map. The other settings will not be influenced. To improve the performance, it is recommended to set all to be changed setting in one map.

As an alternative it is possible to handle the single settings inside ProjectSettings. This is more convenient and more type safe but slower than this property.

Returns
A map of property names and setting values.

◆ GetSignatureByName()

ISignature OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetSignatureByName ( String  fullName)

Gets Signature base on it's full name.

Parameters
fullNameThe full name of signature.
Returns
A Signature with following full name. If no signature was found, return null.

◆ GetStartupDocument()

IDocument OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetStartupDocument ( )

Gets startup Document.

Returns
Startup Document.

◆ GetVersion()

String OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetVersion ( )

Gets Project version.

Returns
Project version.

◆ SetSettings()

void OpenTestSystem.Otx.Runtime.Api.Project.IProject.SetSettings ( Map< String, String >  settings)

Sets the Project Settings.

Sets the Project Settings as a map of names and value pairs. The getter returns all settings. The setter sets only the name value pairs in the given map. The other settings will not be influenced. To improve the performance, it is recommended to set all to be changed setting in one map.

As an alternative it is possible to handle the single settings inside ProjectSettings. This is more convenient and more type safe but slower than this property.

Parameters
settingsA map of property names and setting values.

The documentation for this interface was generated from the following file: