Extensions.ExternalServiceProvider.IsServiceProviderEvent

From emotive
Jump to navigation Jump to search

Classification

Name IsServiceProviderEvent
Short Description Accepts an EventTerm yielding an Event object that has been raised by the OTX runtime
Class Term
Extension OTX ExternalServiceProvider extension
Group ExternalServiceProvider related terms
Exceptions
Checker Rules ExternalServiceProvider_Chk001
ExternalServiceProvider_Chk009
Standard Compliant Yes

OTL Syntax

otx:BooleanTerm ExternalServiceProvider.IsServiceProviderEvent(otx:OtxLink providerType, otx:OtxName eventName, event:EventTerm event, esp:ServiceProviderTerm serviceProvider);

Description

The Extensions.ExternalServiceProvider.IsServiceProviderEvent term accepts an EventTerm yielding an Event object that has been raised by the OTX runtime. The term will return true if and only if the Event originates from a ServiceProviderEventSource. If the eventName attribute is given the term checks if exactly this specified ServiceProvider event was fired. Otherwise it returns false.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
otx:Boolean Accepts an EventTerm yielding an Event object that has been raised by the OTX runtime

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.

eventName otx:OtxName - [0..1] This attribute identifies for which event the values will be returned.
event event:Event Term - [1..1] Represents the Event whose type will be tested.
serviceProvider esp:ServiceProvider Term - [0..1] If specified, the term will return false if the event does not come from the given ServiceProvider.


See also

CreateProvider
DisposeProvider
ExecuteService
GetServiceProviderEventValues
SetProperty
TerminateService
GetProperty
IsDisposed
IsServiceRunning
GetServiceProviderFromEvent
IsServiceExecutionFinishedEvent
ServiceExecutionFinishedEventSource
ServiceProviderEventSource