Difference between revisions of "Extensions.Job.CreateResponse"
Jump to navigation
Jump to search
| 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;"> | ||
| − | + | /// Local Declarations | |
| + | DiagCom.Response ResponseVariable; | ||
| + | /// Flow | ||
| + | ResponseVariable = Job.CreateResponse(ResultTerm, ResponseStates); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 22: | Line 25: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.Result ResultDiag1; | DiagCom.Result ResultDiag1; | ||
DiagCom.Response Response1; | DiagCom.Response Response1; | ||
Revision as of 07:10, 25 October 2018
Contents
Classification
| Name | CreateResponse |
| Short Description | Creates a response inside a result object |
| Class | Term |
| Extension | OTX Job extension |
| Group | Job related terms |
| Exceptions | InvalidParameterizationException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
DiagCom.Response ResponseVariable;
/// Flow
ResponseVariable = Job.CreateResponse(ResultTerm, ResponseStates);Description
The CreateResponse creates a response inside a result object according to a given response state.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Response | The result will be created. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ResponseState | ResponseState | Value | POSITIVE | [0..1] | This optional attribute determines whether a positive or negative response should be created. If the attribute is not set, the default value POSITIVE shall apply implicitly. |
| Result | Result | Term | - | [1] | The result the new response shall be added to. |
OTL Examples
/// Local Declarations
DiagCom.Result ResultDiag1;
DiagCom.Response Response1;
/// Flow
Response1 = Job.CreateResponse(Result1, @JobResponseStates:POSITIVE);