Difference between revisions of "Extensions.Job.GetJobProgress"
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...") |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Job]] | + | {{DISPLAYTITLE: '''GetJobProgress '''}}[[Category:Job]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetJobProgress | | + | {{ClassificationActivity | GetJobProgress | Gets progress information from a '''DiagService''' object | [[Term]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Terms|Job related terms]] | - | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | IntegerTerm Job.GetJobProgress(DiagServiceValue diagJob); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''GetJobProgress''' | + | The '''GetJobProgress''' retrieves progress information out of a [[Extensions.DiagCom.DiagService|DiagService]] object that encapsulates an OTX job. |
| − | {{TermReturnValue| [[Integer]] | Progress information from a '''DiagService'''}} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | Progress information from a '''DiagService'''}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| DiagJob | [[Extensions.DiagCom.DiagService|DiagService]] | [[Value]] | - | [0..1] | This diagnostic service object represents the job from which job progress information will be retrieved.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Integer | + | /// Local Declarations |
| + | |||
| + | DiagCom.DiagService DiagService1; | ||
| + | Integer Integer1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | Integer1 = Job.GetJobProgress(DiagService1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[ | + | [[Extensions.Job.CreateResponse|CreateResponse]] <br/> |
| − | [[CreateResult]] <br/> | + | [[Extensions.Job.CreateResult|CreateResult]] <br/> |
| − | [[GetJobInfo]] | + | [[Extensions.Job.GetJobInfo|GetJobInfo]] |
Latest revision as of 03:28, 13 September 2019
Contents
Classification
| Name | GetJobProgress |
| Short Description | Gets 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(DiagServiceValue diagJob);Description
The GetJobProgress retrieves progress information out of a DiagService object that encapsulates an OTX job.
Return Value
The Term returns the value, see table below.
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 | Value | - | [0..1] | This diagnostic service object represents the job from which job progress information will be retrieved. |
OTL Examples
/// Local Declarations
DiagCom.DiagService DiagService1;
Integer Integer1;
/// Flow
Integer1 = Job.GetJobProgress(DiagService1);