Difference between revisions of "Extensions.Job.GetJobProgress"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Job == Classification == {{ClassificationActivity | GetJobProgress | Get progress information from a '''DiagService''' object | Term | Job|OTX Job extension...")
 
Line 3: Line 3:
 
{{ClassificationActivity | GetJobProgress | Get progress information from a '''DiagService''' object | [[Term]] | [[Job|OTX Job extension]] | [[Job related terms]] | - | - }}
 
{{ClassificationActivity | GetJobProgress | Get progress information from a '''DiagService''' object | [[Term]] | [[Job|OTX Job extension]] | [[Job related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Integer GetJobProgress();
+
IntegerTerm = Job.GetJobProgress(DiagServiceTerm);
 
</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;">
Integer result = GetJobProgress();
+
DiagCom.DiagService DiagService1;
 +
Integer Integer1;
 +
 
 +
Integer1 = Job.GetJobProgress(DiagService1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 08:05, 11 February 2015

Classification

Name GetJobProgress
Short Description Get progress information from a DiagService object
Class Term
Extension OTX Job extension
Group Job related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm = Job.GetJobProgress(DiagServiceTerm);

Description

GetJobProgress brings progress information out of a DiagService object that encapsulates a OTX job.

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
Integer Progress information from a DiagService

Properties

Name Data Type Class Default Cardinality Description
DiagJob DiagService Term - [0..1] This diagnostic service object is a job where progress information to be retrieved from the job.

OTL Examples

DiagCom.DiagService DiagService1;
Integer Integer1;

Integer1 = Job.GetJobProgress(DiagService1);

See also

CreateResult
CreateResult
GetJobInfo