Difference between revisions of "Extensions.ExternalServiceProvider.SetProperty"
Jump to navigation
Jump to search
(Created 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;"> | ||
| − | ActionRealisation ExternalServiceProvider.SetProperty( | + | ActionRealisation ExternalServiceProvider.SetProperty(otx:OtxLink providerType, otx:OtxName property, esp:ServiceProviderTerm serviceProvider, otx:Term value); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 14: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| providerType | [[ | + | {{TableRowPropertie2| providerType | [[OtxLink|otx:OtxLink]] | | - | [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 | [[OtxName|otx:OtxName]] | | - | [1..1] | This attribute identifies the property to set. }} | {{TableRowPropertie2| property | [[OtxName|otx:OtxName]] | | - | [1..1] | This attribute identifies the property to set. }} | ||
| − | {{TableRowPropertie1| serviceProvider | [[Extensions.ExternalServiceProvider. | + | {{TableRowPropertie1| serviceProvider | [[Extensions.ExternalServiceProvider.ServiceProvider|esp:ServiceProvider]] | [[Term]] | | [1..1] | A property of this [[Extensions.ExternalServiceProvider.ServiceProvider|ServiceProvider]] will be set. }} |
{{TableRowPropertie2| value | [[Term|otx:Term]] | [[Term]] | - | [1..1] | This term represents the value that will be stored in the property }} | {{TableRowPropertie2| value | [[Term|otx:Term]] | [[Term]] | - | [1..1] | This term represents the value that will be stored in the property }} | ||
|} | |} | ||
Latest revision as of 12:51, 14 November 2019
Classification
| Name | SetProperty |
| Short Description | Sets the value of a property |
| Class | Action |
| Extension | OTX ExternalServiceProvider extension |
| Group | ExternalServiceProvider related actions |
| Exceptions | esp:ProviderDisposedException otx:TypeMismatchException |
| Checker Rules | ExternalServiceProvider_Chk001 ExternalServiceProvider_Chk007 ExternalServiceProvider_Chk008 |
| Standard Compliant | Yes |
OTL Syntax
ActionRealisation ExternalServiceProvider.SetProperty(otx:OtxLink providerType, otx:OtxName property, esp:ServiceProviderTerm serviceProvider, otx:Term value);
Description
SetProperty is an ActionRealisation which sets the value of a property.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| providerType | otx:OtxLink | - | [1..1] | This attribute identifies the external provider to execute the service on.
The link will point to the corresponding ServiceProviderSignature. | |
| property | otx:OtxName | - | [1..1] | This attribute identifies the property to set. | |
| serviceProvider | esp:ServiceProvider | Term | [1..1] | A property of this ServiceProvider will be set. | |
| value | otx:Term | Term | - | [1..1] | This term represents the value that will be stored in the property |
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 WRITE-ONLY;
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;
/// Flow
ExternalServiceProvider.CreateProvider(ServiceProvider1, ServiceProviderSignature1, ConstructorSignature1, {ConstructorExternalInParameter1 = String1, ConstructorExternalInParameter2 = String1, ConstructorExternalInParameter3 = String3});
ExternalServiceProvider.SetProperty(ServiceProvider1, ServiceProviderSignature1, PropertySignature1, Integer1);
ExternalServiceProvider.DisposeProvider(ServiceProvider1);
}
