Difference between revisions of "Extensions.Job.SendFinalResult"

From emotive
Jump to navigation Jump to search
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''SendFinalResult '''}}
 
{{DISPLAYTITLE:  '''SendFinalResult '''}}
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | SendFinalResult | Delivered the last result | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Core.Actions.Throw.Exception.TypeMismatchException|TypeMismatchException]]<br/>[[Core.Actions.Throw.Exception.InvalidStateException|InvalidStateException]] | - }}
+
{{ClassificationActivity | SendFinalResult | Sends the last 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 ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Job.SendFinalResult(ResultTerm)
+
Job.SendFinalResult(ResultTerm result);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
'''SendFinalResult''' the last result to the instance that sent the job started, before the job is finished.
+
The '''SendFinalResult''' will send the last result before the job exits to the instance which started the job.
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Result | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | This is equivalent to the result that the tester should be sent.}}
+
{{TableRowPropertie2| Result | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | This represents the '''result''' which will be sent to the tester. The term diag:ResultTerm is specified in [[Extensions.DiagCom|the DiagCom extension]]}}
 
|}
 
|}
  
 
== 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 Result1;
 
DiagCom.Result Result1;
 +
 +
/// Flow
  
 
Job.SendFinalResult(Result1);
 
Job.SendFinalResult(Result1);
Line 25: Line 29:
  
 
== See also ==
 
== See also ==
 +
<!--[[Extensions.Job.SendFinalResult|SendFinalResult]]<br/>-->
 
[[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/>
 
[[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/>
 
[[Extensions.Job.SetJobInfo|SetJobInfo]]<br/>
 
[[Extensions.Job.SetJobInfo|SetJobInfo]]<br/>

Latest revision as of 03:25, 13 September 2019

Classification

Name SendFinalResult
Short Description Sends the last 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.SendFinalResult(ResultTerm result);

Description

The SendFinalResult will send the last result before the job exits 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. The term diag:ResultTerm is specified in the DiagCom extension

OTL Examples

/// Local Declarations

DiagCom.Result Result1;

/// Flow

Job.SendFinalResult(Result1);

See also

SendIntermediateResult
SetJobInfo
SetProgressInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc