Difference between revisions of "Extensions.Job.CreateResponse"
Jump to navigation
Jump to search
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''CreateResponse '''}}[[Category:Job]] | {{DISPLAYTITLE: '''CreateResponse '''}}[[Category:Job]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateResponse | | + | {{ClassificationActivity | CreateResponse | Creates a response inside a result object | [[Term]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Terms|Job related terms]] | [[Extensions.Job.InvalidParameterizationException|InvalidParameterizationException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ResponseTerm | + | ResponseTerm Job.CreateResponse(ResultTerm result, ResponseStates responseState); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''CreateResponse''' a response | + | The '''CreateResponse''' creates a response inside a result object according to a given response state. |
| − | {{TermReturnValue| [[Extensions.DiagCom.Response|Response]] | The result will be | + | {{TermReturnValue| [[Extensions.DiagCom.Response|Response]] | The result will be created.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ResponseState | [[Extensions.DiagCom.ResponseState|ResponseState]] | [[Value]] | | + | {{TableRowPropertie1| ResponseState | [[Extensions.DiagCom.ResponseState|ResponseState]] | [[Value]] | POSITIVE | [0..1] | This optional attribute determines whether a positive or negative response will be created. If the attribute is not set, the default value POSITIVE will apply implicitly.}} |
| + | {{TableRowPropertie2| Result| [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | The result the new response will be added to.}} | ||
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagCom.Result | + | /// Local Declarations |
| + | |||
| + | DiagCom.Result Result1; | ||
DiagCom.Response Response1; | DiagCom.Response Response1; | ||
| − | Response1 = Job.CreateResponse(@JobResponseStates:POSITIVE | + | /// Flow |
| + | |||
| + | Response1 = Job.CreateResponse(Result1, @JobResponseStates:POSITIVE); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 03:27, 13 September 2019
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
ResponseTerm Job.CreateResponse(ResultTerm result, ResponseStates responseState);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 will be created. If the attribute is not set, the default value POSITIVE will apply implicitly. |
| Result | Result | Term | - | [1] | The result the new response will be added to. |
OTL Examples
/// Local Declarations
DiagCom.Result Result1;
DiagCom.Response Response1;
/// Flow
Response1 = Job.CreateResponse(Result1, @JobResponseStates:POSITIVE);