Difference between revisions of "Extensions.Job.SendIntermediateResult"

From emotive
Jump to navigation Jump to search
(Created page with "== Classification == {{ClassificationActivity | SendIntermediateResult | Send intermediate result | Action | OTX Job extension | Job related actions | TypeMi...")
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{DISPLAYTITLE:  '''SendIntermediateResult '''}}
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | SendIntermediateResult | Send intermediate result | [[Action]] | [[Job|OTX Job extension]] | [[Job related actions]] | [[TypeMismatchException]]<br/>[[InvalidStateException]] | - }}
+
{{ClassificationActivity | SendIntermediateResult | Sends an intermediate result to the instance| [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Actions|Job related actions]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]]<br/>[[Extensions.DiagCom.InvalidStateException|InvalidStateException]] | - }}
 +
 
 +
== OTL Syntax ==
 +
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
Job.SendIntermediateResult(ResultTerm result);
 +
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
'''SendIntermediateResult''' is the value of a '''ResultTerm''' as intermediate result to the send the instance that initiated the job
+
The '''SendIntermediateResult''' will send the value of a '''diag:ResultTerm''' as an intermediate result to the instance which started the job.
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Result | [[Result]] | [[Term]] | - | [1] | This represents the result which shall be sent tothe tester as an intermediate result.}}
+
{{TableRowPropertie2| Result | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | This represents the '''result''' which will be sent to the tester as an intermediate result. The term '''diag:ResultTerm''' is specified in [[Extensions.DiagCom|the DiagCom extension]].}}
 
|}
 
|}
 +
 +
== OTL Examples ==
 +
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 +
DiagCom.Result Result1;
 +
 +
/// Flow
 +
 +
Job.SendIntermediateResult(Result1);
 +
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[SendFinalResult]]<br/>
+
[[Extensions.Job.SendFinalResult|SendFinalResult]]<br/>
[[SetJobInfo]]<br/>
+
<!--[[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/>-->
[[SetProgressInfo]]<br/>
+
[[Extensions.Job.SetJobInfo|SetJobInfo]]<br/>
[[AddElement]]<br/>
+
[[Extensions.Job.SetProgressInfo|SetProgressInfo]]<br/>
[[AddBranchByName]]<br/>
+
[[Extensions.Job.AddElement|AddElement]]<br/>
[[AddBranchByIndex]]<br/>
+
[[Extensions.Job.AddBranchByName|AddBranchByName]]<br/>
[[AddBranchByValue]]<br/>
+
[[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/>
[[AddEnvDataByDtc]]
+
[[Extensions.Job.AddBranchByValue|AddBranchByValue]]<br/>
 +
[[Extensions.Job.AddEnvDataByDtc|AddEnvDataByDtc]]

Latest revision as of 03:25, 13 September 2019

Classification

Name SendIntermediateResult
Short Description Sends an intermediate result to the instance
Class Action
Extension OTX Job extension
Group Job related actions
Exceptions TypeMismatchException
InvalidStateException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Job.SendIntermediateResult(ResultTerm result);

Description

The SendIntermediateResult will send the value of a diag:ResultTerm as an intermediate result to the instance which started the job.

Properties

Name Data Type Class Default Cardinality Description
Result Result Term - [1] This represents the result which will be sent to the tester as an intermediate result. The term diag:ResultTerm is specified in the DiagCom extension.

OTL Examples

/// Local Declarations

DiagCom.Result Result1;

/// Flow

Job.SendIntermediateResult(Result1);

See also

SendFinalResult
SetJobInfo
SetProgressInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc