Represents an OTX ContextVariable. More...

Public Member Functions
String	GetAppId ()
	Gets app ID. More...

String	GetDataType ()
	Gets DataType. More...

IDocument	GetDocument ()
	Gets Document. More...

Map< String, String >	GetExternalApps ()
	Gets all externals applications of current OTX mapping. More...

Object	GetInitValue ()
	Gets initial value. More...

int	GetMappingIndex ()
	Gets mapping index. More...

String	GetMappingName ()
	Gets mapping name. More...

String	GetName ()
	Gets variable name. More...

String	GetSpecification ()
	Gets specification. More...

boolean	IsEnvironmentValueActive ()
	The environment value setting was set for the parameter. More...

Detailed Description

Represents an OTX ContextVariable.

Member Function Documentation

◆ GetAppId()

String OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetAppId ( )

Gets app ID.

Returns: App ID.

◆ GetDataType()

String OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetDataType ( )

Gets DataType.

Returns: DataType name.

◆ GetDocument()

IDocument OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetDocument ( )

Gets Document.

Returns: A Document which this variable belongs to.

◆ GetExternalApps()

Map<String, String> OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetExternalApps ( )

Gets all externals applications of current OTX mapping.

All APPs used in the current mapping are returned as a Dictionary. The key is a String and contains the AppId. The value is a String and contains the path of the application. If available, the names of the initialization and deinitialization methods as well as the names of the parameters and the parameter values are also returned.

{       
   "AppId1"             = "Production.Otx.Screens.dll",
   "AppId1.Init"        = "InitMethod",
   "AppId1.Init.Param1" = "1",
   "AppId1.Init.Param2" = "Message",
   "AppId1.Deinit"      = "DeinitMethod",
   "AppId2"             = "GalaSoft.MvvmLight.dll",
   "AppId3"             = "GalaSoft.MvvmLight.Platform.dll",
   "AppId4"             = "System.Windows.Interactivity.dll",
   "AppId5"             = "BitFactory.Logging.dll"
}

Returns: A Dictionary String of String.

◆ GetInitValue()

Object OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetInitValue ( )

Gets initial value.

Returns: Initial value.

◆ GetMappingIndex()

int OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetMappingIndex ( )

Gets mapping index.

If a mapping is related to a list element, the function will return the relate index.

If no mapping a list element, this function will return -1.

Returns: Mapping index.

◆ GetMappingName()

String OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetMappingName ( )

Gets mapping name.

If a valid mapping exists for this Variable, this function will return the related mapping name. The value can be used to make the application independent from different OTX projects which should be use the same system resource.

If no valid mapping exists, this function will return NULL.

The mapping name is the full qualified name of the element inside the external application which is mapped to this Variable. It contains all namespace elements separated by dots (".").

Returns: Mapping name.

◆ GetName()

String OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetName ( )

Gets variable name.

Returns: Variable name.

◆ GetSpecification()

String OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.GetSpecification ( )

Gets specification.

Returns: specification

◆ IsEnvironmentValueActive()

boolean OpenTestSystem.Otx.Runtime.Api.Otx.IContextVariable.IsEnvironmentValueActive ( )

The environment value setting was set for the parameter.

Returns: Returns true if the environment value setting was set for the related parameter. Using the environment value setting, unmapped InOut or Out parameters as well as context variables can be set to a fixed value. This means that a non-existent environment can be simulated.

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

IContextVariable.java

Public Member Functions