Extensions.ExternalServiceProvider.ServiceProviderEventSource

From emotive
Jump to navigation Jump to search

Classification

Name ServiceProviderEventSource
Short Description An EventSource which an event source for all provider events
Class Term
Extension OTX ExternalServiceProvider extension
Group ExternalServiceProvider related terms
Exceptions
Checker Rules ExternalServiceProvider_Chk001
ExternalServiceProvider_Chk009
Standard Compliant Yes

OTL Syntax

event:EventSourceTerm ExternalServiceProvider.ServiceProviderEventSource(otx:OtxLink providerType, otx:OtxName eventName, esp:ServiceProviderTerm serviceProvider);

Description

The ServiceProviderEventSource is an EventSourceTerm which is an event source for all provider events.
Depending of the usage of the term three different selections of events can be realised:

  • Only the mandatory providerType attribute is given. All ServiceProviderEvents of all service provider instances of a given providerType are returned.
  • The mandatory providerType attribute and the eventName attribute are given. The ServiceProviderEvents defined by eventName of all service provider instances of a given providerType are returned.
  • The mandatory providerType attribute the eventName attribute, and the serviceProvider term are given. The ServiceProviderEvents defined by eventName of a specific service provider instance of a given providerType are returned.

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
event:EventSource An event source for all provider events.

Properties

Name Data Type Class Default Cardinality Description
providerType otx:OtxLink - [1..1] This attribute identifies the external provider. The link will point to the corresponding ServiceProviderSignature.
eventName otx:OtxName - [0..1] This attribute identifies the name of the event that is used to select a specific event. The link will point to the corresponding event in the EventSignature.
serviceProvider esp:ServiceProvider Term - [0..1] The serviceProvider is a specific Instance of a ServiceProvider as a result of a ServiceProvider Term.


See also

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