Difference between revisions of "Extensions.ExternalServiceProvider.GetProperty"
Jump to navigation
Jump to search
(Edited by Ngoc Tran.) |
(Edited by Ngoc Tran.) |
||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Term ExternalServiceProvider.GetProperty( | + | Term ExternalServiceProvider.GetProperty(ServiceProviderSignature providerType, OtxLink providerType, ServiceProviderTerm serviceProvider); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| providerType | [[Extensions.ExternalServiceProvider.ServiceProviderSignature|ServiceProviderSignature]] | | - | [1..1] |This attribute identifies the external provider to execute the service on. | + | {{TableRowPropertie1| providerType | [[Extensions.ExternalServiceProvider.ServiceProviderSignature|esp:ServiceProviderSignature]] | | - | [1..1] |This attribute identifies the external provider to execute the service on. |
The link will point to the corresponding [[Extensions.ExternalServiceProvider.ServiceProviderSignature|ServiceProviderSignature]]. }} | The link will point to the corresponding [[Extensions.ExternalServiceProvider.ServiceProviderSignature|ServiceProviderSignature]]. }} | ||
{{TableRowPropertie2| property | [[Extensions.ExternalServiceProvider.PropertySignature|esp:PropertySignature]] | [[Variable]] | - | [1..1] |This attribute identifies the property to get. }} | {{TableRowPropertie2| property | [[Extensions.ExternalServiceProvider.PropertySignature|esp:PropertySignature]] | [[Variable]] | - | [1..1] |This attribute identifies the property to get. }} | ||
Revision as of 03:31, 14 November 2019
Contents
Classification
| Name | GetProperty |
| Short Description | Gets the value of a property from a service provider |
| Class | Term |
| Extension | OTX ExternalServiceProvider extension |
| Group | ExternalServiceProvider related terms |
| Exceptions | esp:ProviderDisposedException otx:TypeMismatchException |
| Checker Rules | ExternalServiceProvider_Chk001 ExternalServiceProvider_Chk007 ExternalServiceProvider_Chk008 |
| Standard Compliant | Yes |
OTL Syntax
Term ExternalServiceProvider.GetProperty(ServiceProviderSignature providerType, OtxLink providerType, ServiceProviderTerm serviceProvider);Description
GetProperty is a term, which gets the value of a property from a service provider.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Term | The value of a property from a service provider |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| providerType | esp:ServiceProviderSignature | - | [1..1] | This attribute identifies the external provider to execute the service on.
The link will point to the corresponding ServiceProviderSignature. | |
| property | esp:PropertySignature | Variable | - | [1..1] | This attribute identifies the property to get. |
| serviceProvider | esp:ServiceProvider | Term | - | [1..1] | A property of this ServiceProvider will be read. |
OTL 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 READ-WRITE;
ExternalServiceProvider.ServiceSignature ServiceSignature1(in ByteField ExternalInParameterDeclaration1, ref Float ExternalInOutParameterDeclaration1, out Integer ExternalOutParameterDeclaration1) throws ExternalServiceProvider.ConfigurationException, ExternalServiceProvider.ExecuteException, ExternalServiceProvider.ProviderServiceException;
}
package HMI.ScreenSignature ScreenSignature1();
/// Global Declarations
public procedure main()
{
/// Local Declarations
ExternalServiceProvider.ServiceProvider ServiceProvider1;
String String1 = "Abc";
String String2 = "Def";
String String3 = "Ghi";
Integer Integer1 = 5678;
ExternalServiceProvider.Service Service1;
Boolean Boolean1 = false;
ByteField ByteField1;
Float Float1;
/// 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);
}