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

Contains Projects. More...

Public Member Functions

String GetName ()
 Gets PlayerProject name. More...
 
String GetPlayerLayoutPath ()
 Gets Layout path. More...
 
String GetPlaylistPath ()
 Gets Playlist path. More...
 
IProject[] GetProjects ()
 Gets all Projects. More...
 
IProjectSettings GetProjectSettings ()
 Gets the Project Settings. More...
 
Map< String, String > GetSettings ()
 Gets the Project Settings. More...
 
String GetVersion ()
 Gets PlayerProject version. More...
 
void SetSettings (Map< String, String > settings)
 Sets the Project Settings. More...
 

Detailed Description

Contains Projects.

Member Function Documentation

◆ GetName()

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

Gets PlayerProject name.

Returns
PlayerProject name.

◆ GetPlayerLayoutPath()

String OpenTestSystem.Otx.Runtime.Api.Project.IPlayerProject.GetPlayerLayoutPath ( )

Gets Layout path.

Returns
>Path of Layout file.

◆ GetPlaylistPath()

String OpenTestSystem.Otx.Runtime.Api.Project.IPlayerProject.GetPlaylistPath ( )

Gets Playlist path.

Returns
Path of Playlist file.

◆ GetProjects()

IProject [] OpenTestSystem.Otx.Runtime.Api.Project.IPlayerProject.GetProjects ( )

Gets all Projects.

Returns
A list of Projects.

◆ GetProjectSettings()

IProjectSettings OpenTestSystem.Otx.Runtime.Api.Project.IPlayerProject.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.

◆ GetSettings()

Map<String, String> OpenTestSystem.Otx.Runtime.Api.Project.IPlayerProject.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.

◆ GetVersion()

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

Gets PlayerProject version.

Returns
PlayerProject version.

◆ SetSettings()

void OpenTestSystem.Otx.Runtime.Api.Project.IPlayerProject.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: