Difference between revisions of "Extensions.Job.CreateResponse"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Job == Classification == {{ClassificationActivity | CreateResponse | Create response within a result object | Term | OTX Job extension | Job related...")
 
Line 3: Line 3:
 
{{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]] | [[Job|OTX Job extension]] | [[Job related terms]] | [[InvalidParameterizationException]] | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Response CreateResponse(ResponseState state);
+
ResponseTerm = Job.CreateResponse(@JobResponseStates:POSITIVE, ResultTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 19:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Response result = CreateResponse(@ResponseState:POSITIVE);
+
DiagCom.Result ResultDiag1;
 +
DiagCom.Response Response1;
 +
 
 +
Response1 = Job.CreateResponse(@JobResponseStates:POSITIVE, ResultDiag1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 07:51, 11 February 2015

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.

Icons Note.png 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);

See also

CreateResult
GetJobInfo
GetJobProgress