Extensions.Job.CreateResult
Jump to navigation
Jump to search
Contents
Classification
| Name | CreateResult |
| Short Description | Create a result object |
| Class | Term |
| Extension | OTX Job extension |
| Group | Job related terms |
| Exceptions | InvalidParameterizationException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ResultTerm = Job.CreateResult(ResultTypes, SeverityTypes, IntegerTerm, IntegerTerm, DiagServiceTerm, StringTerm, StringTerm);Description
CreateResult term creates a Result object that can be returned to the caller of the OTX job sequence.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Result | A Result object that can be returned to the caller of the OTX job sequence. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Result Type | Result Type | Value | @ResultTypes:REQUEST_AND_RESPONSE | [0..1] | The type of the result to be produced. The allowed values are defined by the ResultTypes enumeration, as ResultTypes = {REQUEST | RESPONSE | REQUEST_AND_RESPONSE}. If the attribute is not set, the default value is implicitly REQUEST_AND_RESPONSE apply. |
| Severity | SeverityType | Value | @SeverityType:ERROR | [0..1] | The attribute is the result (if any) connected. The allowed values are defined by the enumeration SeverityTypes where SeverityTypes = {ERROR | FATAL_ERROR | MESSAGE | TERMINATE | WARNING}. If the attribute is not set, the default value ERROR is implicitly apply. |
| ErrorCode | Int | - | - | [0..1] | An error code of type integer, which is joined to the result (if applicable) |
| VendorCode | Int | - | - | [0..1] | A supplier code of type integer, which is joined to the result (if applicable) |
| DiagService | DiagService | Term | - | [1] | The DiagService, on the surgery of the term and on the cut, the result is tailored to |
| CodeDescription | String | Term | - | [0..1] | A code description (if applicable) is connected to the error code in the result. |
| VendorCodeDescription | String | Term | - | [0..1] | A party code description that is Connected to the provider code of the result (if applicable) |
OTL Examples
DiagCom.Result Result1;
DiagCom.Response Response1;
DiagCom.DiagService DiagService1;
Result1 = Job.CreateResult(@ResultTypes:REQUEST_AND_RESPONSE, @SeverityTypes:ERROR, 0, 0, DiagService1, "Description", "VenderCode");