OTX Reference  
OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Terms.GetProperty Class Reference

Gets the value of a property from a service provider More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Terms.GetProperty:
Inheritance graph

Public Attributes

OtxName property
 This attribute identifies the property to get More...
 
OtxLink providerType
 This attribute identifies the external provider. The link shall point to the corresponding ServiceProviderSignature. More...
 
ServiceProviderTerm serviceProvider
 A property of this ServiceProvider will be read More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData metaData
 Cardinality [0..1]
The MetaData type allows tools to store additional, mainly tool-specific data. More...
 

Detailed Description

Gets the value of a property from a service provider

The GetProperty activity gets the value of a property from a service provider.

Exceptions
Exceptions.ProviderDisposedExceptionIf the provider is already disposed this exception shall be thrown.
Exceptions.ConfigurationExceptionIf the preconditions for getting the property are not fullfilled, e.g. if the proprietary binding is incomplete.
  • No mapping
  • Not found property
Exceptions.ExecuteExceptionIf getting the property aborts abnormally, this exception will be thrown.
Core.Exceptions.TypeMismatchExceptionIf the data type of the property is incompatible to the corresponding property of the proprietary binding.
Checker rules
CheckerRule.ExternalServiceProvider_Chk001 - Correct target for service provider
CheckerRule.ExternalServiceProvider_Chk007 - Correct property attribute reference
CheckerRule.ExternalServiceProvider_Chk008 - Correct Property access
CheckerRule.ExternalServiceProvider_Chk012 - Correct provider types

Syntax
Term = ExternalServiceProvider.GetProperty(ServiceProviderTerm serviceProvider, OtxName property);
ServiceProviderTerm serviceProvider
A property of this ServiceProvider will be read
Definition: ExternalServiceProvider.cs:3369
OtxName property
This attribute identifies the property to get
Definition: ExternalServiceProvider.cs:3391
Examples
// Signatures
package ExternalServiceProvider.ServiceProviderSignature ServiceProviderSignature1
{
ExternalServiceProvider.ConstructorSignature ConstructorSignature1(String ConstructorExternalInParameter1, String ConstructorExternalInParameter2, String ConstructorExternalInParameter3);
ExternalServiceProvider.EventSignature EventSignature1(String EventValueParameterDeclaration1);
ExternalServiceProvider.PropertySignature PropertySignature1(String PropertyValueDeclaration1) accessType WRITE-ONLY;
ExternalServiceProvider.ServiceSignature ServiceSignature1(in ByteField ExternalInParameterDeclaration1, ref Float ExternalInOutParameterDeclaration1, out Integer ExternalOutParameterDeclaration1) throws ExternalServiceProvider.ConfigurationException, ExternalServiceProvider.ExecuteException, ExternalServiceProvider.ProviderServiceException;
}
// Global Declarations
public procedure main()
{
// Local Declarations
ExternalServiceProvider.ServiceProvider ServiceProvider1;
String String1 = "Abc";
String String2 = "Def";
String String3 = "Ghi";
ExternalServiceProvider.Service Service1;
ByteField ByteField1 = &1234;
Integer Integer1 = 5678;
Float Float1 = 9.9;
Boolean Boolean1 = false;
// Flow
ExternalServiceProvider.CreateProvider(ServiceProvider1, ServiceProviderSignature1, ConstructorSignature1, { ConstructorExternalInParameter1 = String1, ConstructorExternalInParameter2 = String1, ConstructorExternalInParameter3 = String3});
ExternalServiceProvider.ExecuteService(ServiceProvider1, ServiceProviderSignature1, ServiceSignature1, {ExternalInParameterDeclaration1 = ByteField1, ExternalInOutParameterDeclaration1 = Float1, ExternalOutParameterDeclaration1 = Integer1}, Service1, false);
String2 = ExternalServiceProvider.GetProperty(ServiceProvider1, ServiceProviderSignature1, PropertySignature1);
ExternalServiceProvider.TerminateService(Service1, Boolean1);
ExternalServiceProvider.DisposeProvider(ServiceProvider1);
}

Member Data Documentation

◆ property

OtxName OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Terms.GetProperty.property

This attribute identifies the property to get

◆ providerType

OtxLink OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Terms.GetProperty.providerType

This attribute identifies the external provider. The link shall point to the corresponding ServiceProviderSignature.

◆ serviceProvider

ServiceProviderTerm OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Terms.GetProperty.serviceProvider

A property of this ServiceProvider will be read