Difference between revisions of "Extensions.ExternalServiceProvider.IsServiceProviderEvent"
Jump to navigation
Jump to search
(→OTL Syntax: 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;"> | ||
| − | BooleanTerm ExternalServiceProvider.IsServiceProviderEvent( | + | otx:BooleanTerm ExternalServiceProvider.IsServiceProviderEvent(otx:OtxLink providerType, otx:OtxName eventName, event:EventTerm event, esp:ServiceProviderTerm serviceProvider); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| providerType | [[ | + | {{TableRowPropertie1| 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| eventName | [[ | + | {{TableRowPropertie2| eventName | [[OtxName|otx:OtxName]] | | - | [0..1] | This attribute identifies for which event the values will be returned. }} |
{{TableRowPropertie1| event | [[Event|event:Event]] | [[Term]] | - | [1..1] | Represents the [[Event]] whose type will be tested. }} | {{TableRowPropertie1| event | [[Event|event:Event]] | [[Term]] | - | [1..1] | Represents the [[Event]] whose type will be tested. }} | ||
{{TableRowPropertie2| serviceProvider | [[Extensions.ExternalServiceProvider.ServiceProvider|esp:ServiceProvider]] | [[Term]] | - | [0..1] | If specified, the term will return false if the event does not come from the given [[Extensions.ExternalServiceProvider.ServiceProvider|ServiceProvider]]. }} | {{TableRowPropertie2| serviceProvider | [[Extensions.ExternalServiceProvider.ServiceProvider|esp:ServiceProvider]] | [[Term]] | - | [0..1] | If specified, the term will return false if the event does not come from the given [[Extensions.ExternalServiceProvider.ServiceProvider|ServiceProvider]]. }} | ||
Latest revision as of 12:59, 14 November 2019
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.
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. |
