OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter Interface Reference

Base of ExternalParameters. More...

Inheritance diagram for OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter:

Public Member Functions
String	GetDataType ()
	Gets the data type of the parameter as a string. More...
Object	GetInitValue ()
	Gets initial value. More...
int	GetMappingIndex ()
	Gets mapping index. More...
String	GetMappingName ()
	Gets mapping name. More...
String	GetName ()
	Gets name. More...
String	GetSpecification ()
	Gets specification. More...

Detailed Description

Base of ExternalParameters.

Member Function Documentation

GetDataType()

String OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter.GetDataType

(

)

Gets the data type of the parameter as a string.

Returns the parameter’s data type as a string, supporting simple types like Integer, String or ByteField, as well as more complex structures such as List<String>, Map<String, Integer>, or nested types like Map<List<Integer>>.

DataType	Property value as String
String	"String"
Integer	"Integer"
Float	"Float"
Boolean	"Boolean"
ByteField	"ByteField"
Map	"Map<Integer, String>, Map<String, List<Integer>>" (Example)
List	"List<Integer>, List<Map<String, List<Integer>>" (Example)
Enumeration	"OtxPackage.Document.Color" (Example)
Structure	"OtxPackage.Document.MyStructure<Integer, String>, OtxPackage.Document.Person<StructureElement<Name, String>, StructureElement<Age, Integer>, StructureElement<Family, List<Person>>>"

Notes: A Structure has a data type formatted as follows: "StructureSignatureName<Datatype1, DataType2, ...>". However, when the Structure contains a List, Map of Structure, it is described as follows: "StructureSignatureName<StructureElement<ElementName1, DataType1>, StructureElement<ElementName2, DataType2>, ...>".

Returns

DataType.

GetInitValue()

Object OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter.GetInitValue

(

)

Gets initial value.

Returns

Initial value.

GetMappingIndex()

int OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter.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.Custom.ExternalServiceProviderImplementation.IExternalParameter.GetMappingName

(

)

Gets mapping name.

If a valid mapping exists for this Parameter, 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. If there are more than one mapping name related to this Parameter, they will be concatenated with ", ". If a mapping is related to a list element, the mapping name contains the index of the list element in format "MyMappingList[0]".

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

Returns

Mapping name.

GetName()

String OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter.GetName

(

)

Gets name.

Returns

Name.

GetSpecification()

String OpenTestSystem.Otx.Runtime.Api.Custom.ExternalServiceProviderImplementation.IExternalParameter.GetSpecification

(

)

Gets specification.

Returns

Specification.

---

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

• IExternalParameter.java