Difference between revisions of "Extensions.Job.GetJobInfo"

From emotive
Jump to navigation Jump to search
m (Hb moved page GetJobInfo to Extensions.Job.GetJobInfo: #3153)
Line 1: Line 1:
[[Category:Job]]
+
{{DISPLAYTITLE:  '''GetJobInfo '''}}[[Category:Job]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetJobInfo | Get information from '''DiagService''' object | [[Term]] | [[Job|OTX Job extension]] | [[Job related terms]] | - | - }}
+
{{ClassificationActivity | GetJobInfo | Get information from '''DiagService''' object | [[Term]] | [[Extensions.Job|OTX Job extension]] | [[Job related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
'''GetJobInfo''' retrieves information from a [[DiagService]] out object that encapsulates a OTX job.
+
'''GetJobInfo''' retrieves information from a [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] out object that encapsulates a OTX job.
  
{{TermReturnValue| [[String]] |  Information from a '''DiagService'''}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] |  Information from a '''DiagService'''}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| DiagJob | [[DiagService]] | [[Term]] | - | [0..1] | This diagnostic service object is a job where job information is to be retrieved.}}
+
{{TableRowPropertie1| DiagJob | [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] | [[Term]] | - | [0..1] | This diagnostic service object is a job where job information is to be retrieved.}}
 
|}
 
|}
  
Line 28: Line 28:
  
 
== See also ==
 
== See also ==
[[CreateResult]] <br/>
+
[[Extensions.Job.CreateResponse|CreateResponse]] <br/>
[[CreateResult]] <br/>
+
[[Extensions.Job.CreateResult|CreateResult]] <br/>
[[GetJobProgress]]
+
[[Extensions.Job.GetJobProgress|GetJobProgress]]

Revision as of 10:49, 15 February 2016

Classification

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

OTL Syntax

StringTerm = Job.GetJobInfo(DiagServiceTerm);

Description

GetJobInfo retrieves information from a DiagService out 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
String 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 job information is to be retrieved.

OTL Examples

DiagCom.DiagService DiagService1;
String String1;

String1 = Job.GetJobInfo(DiagService1);

See also

CreateResponse
CreateResult
GetJobProgress