Difference between revisions of "Extensions.Job.CreateResponse"
Jump to navigation
Jump to search
m (Hb moved page CreateResponse to Extensions.Job.CreateResponse: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Job]] | + | {{DISPLAYTITLE: '''CreateResponse '''}}[[Category:Job]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateResponse | Create response within a result object | [[Term]] | [[Job|OTX Job extension]] | [[Job related terms]] | [[InvalidParameterizationException]] | - }} | + | {{ClassificationActivity | CreateResponse | Create response within a result object | [[Term]] | [[Extensions.Job|OTX Job extension]] | [[Job related terms]] | [[Extensions.Job.InvalidParameterizationException|InvalidParameterizationException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 11: | Line 11: | ||
'''CreateResponse''' a response within a resultobject created State after a specified response. | '''CreateResponse''' a response within a resultobject created State after a specified response. | ||
| − | {{TermReturnValue| [[Response]] | The result will be added to the new response.}} | + | {{TermReturnValue| [[Extensions.DiagCom.Response|Response]] | The result will be added to the new response.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ResponseState | [[ResponseState]] | [[Value]] | @ResponseState:POSITIVE | [0..1] | This optional attribute determines whether to create a positive or negative response. If the attribute is not set, the default value of POSITIVE will be implicitly.}} | + | {{TableRowPropertie1| ResponseState | [[Extensions.DiagCom.ResponseState|ResponseState]] | [[Value]] | @ResponseState:POSITIVE | [0..1] | This optional attribute determines whether to create a positive or negative response. If the attribute is not set, the default value of POSITIVE will be implicitly.}} |
|} | |} | ||
| Line 28: | Line 28: | ||
== See also == | == See also == | ||
| − | [[CreateResult]] <br/> | + | [[Extensions.Job.CreateResult|CreateResult]] <br/> |
| − | [[GetJobInfo]] <br/> | + | [[Extensions.Job.GetJobInfo|GetJobInfo]] <br/> |
| − | [[GetJobProgress]] | + | [[Extensions.Job.GetJobProgress|GetJobProgress]] |
Revision as of 10:42, 15 February 2016
Contents
Classification
| Name | CreateResponse |
| Short Description | Create response within 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(@JobResponseStates:POSITIVE, ResultTerm);Description
CreateResponse a response within a resultobject created State after a specified response.
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 added to the new response. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ResponseState | ResponseState | Value | @ResponseState:POSITIVE | [0..1] | This optional attribute determines whether to create a positive or negative response. If the attribute is not set, the default value of POSITIVE will be implicitly. |
OTL Examples
DiagCom.Result ResultDiag1;
DiagCom.Response Response1;
Response1 = Job.CreateResponse(@JobResponseStates:POSITIVE, ResultDiag1);