OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.GetServiceProviderEventValues Class Reference

Retrieves the values of a provider event More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.GetServiceProviderEventValues:

Classes
class	ExternalEventResult
	The event values of the event can be returned to variables More...

Public Attributes
EventTerm	_event
	Represents the value of a ServiceProviderEvent. More...
OtxName	eventName
	This attribute identifies the EventSignature in the given ServiceProviderSignature for which event the values shall be returned More...
OtxLink	providerType
	This attribute identifies the external provider to execute the service on. The link shall point to the corresponding ServiceProviderSignature More...
ExternalEventResult[]	value
	Here the event values of the event can be returned to variables. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink	validFor
	Validity of ActionRealisation. More...

Detailed Description

Retrieves the values of a provider event

The GetServiceProviderEventValues activity retrieves the values of a provider event. To address the right ServiceProviderEvent the EventName and the ProviderType should be adjusted. If the event inside the event attribute does not match to the specified ServiceProviderEvent an TypeMismatchException shall be thrown.

Exceptions

Exceptions.ProviderDisposedException
Core.Exceptions.TypeMismatchException

Checker rules

CheckerRule.ExternalServiceProvider_Chk001 - Correct target for service provider
CheckerRule.ExternalServiceProvider_Chk009 - Correct event attribute reference
CheckerRule.ExternalServiceProvider_Chk011 - Correct Event values

Syntax

ExternalServiceProvider.GetServiceProviderEventValues(OtxLink providerType, OtxName eventName, EventTerm event, ExternalEventResult value);

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;
    EventHandling.Event Event1;
    Boolean Boolean1 = false;
    EventHandling.EventSource EventSource1;
 
    // Flow
    ExternalServiceProvider.CreateProvider(ServiceProvider1, ServiceProviderSignature1, ConstructorSignature1, { ConstructorExternalInParameter1 = String1, ConstructorExternalInParameter2 = String1, ConstructorExternalInParameter3 = String3});
    EventSource1 = EventHandling.MonitorChangeEventSource(String3);
    EventHandling.WaitForEvent({EventSource1, EventHandling.TimerExpiredEventSource(1000)}, Event1);
 
    try
    {
    ExternalServiceProvider.GetServiceProviderEventValues(Event1, ServiceProviderSignature1, EventSignature1, {EventValueParameterDeclaration1 = String2});
    }
    catch (TypeMismatchException)
    {
    }
 
    ExternalServiceProvider.DisposeProvider(ServiceProvider1);
}

Member Data Documentation

_event

EventTerm OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.GetServiceProviderEventValues._event

Represents the value of a ServiceProviderEvent.

eventName

OtxName OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.GetServiceProviderEventValues.eventName

This attribute identifies the EventSignature in the given ServiceProviderSignature for which event the values shall be returned

providerType

OtxLink OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.GetServiceProviderEventValues.providerType

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

value

ExternalEventResult [] OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.GetServiceProviderEventValues.value

Here the event values of the event can be returned to variables.