Difference between revisions of "Extensions.Job.GetJobProgress"
Jump to navigation
Jump to search
m (Hb moved page GetJobProgress to Extensions.Job.GetJobProgress: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Job]] | + | {{DISPLAYTITLE: '''GetJobProgress '''}}[[Category:Job]] |
== Classification == | == Classification == | ||
| − | {{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]] | [[Extensions.Job|OTX Job extension]] | [[Job related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | '''GetJobProgress''' brings progress information out of a [[DiagService]] object that encapsulates a OTX job. | + | '''GetJobProgress''' brings progress information out of a [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] object that encapsulates a 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}} | ||
| − | {{TableRowPropertie1| DiagJob | [[DiagService]] | [[Term]] | - | [0..1] | This diagnostic service object is a job where progress information to be retrieved from the job.}} | + | {{TableRowPropertie1| DiagJob | [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] | [[Term]] | - | [0..1] | This diagnostic service object is a job where progress information to be retrieved from the job.}} |
|} | |} | ||
| Line 28: | Line 28: | ||
== See also == | == See also == | ||
| − | [[ | + | [[Extensions.Job.CreateResponse|CreateResponse]] <br/> |
| − | [[CreateResult]] <br/> | + | [[Extensions.Job.CreateResult|CreateResult]] <br/> |
| − | [[GetJobInfo]] | + | [[Extensions.Job.GetJobInfo|GetJobInfo]] |
Revision as of 10:51, 15 February 2016
Contents
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.
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);