Extensions.Job.CreateResponse

From emotive
Jump to navigation Jump to search

Classification

Name CreateResponse
Short Description Creates a response inside a result object
Class Term
Extension OTX Job extension
Group Job related terms
Exceptions InvalidParameterizationException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ResponseTerm Job.CreateResponse(ResultTerm result, ResponseStates responseState);

Description

The CreateResponse creates a response inside a result object according to a given response state.

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
Response The result will be created.

Properties

Name Data Type Class Default Cardinality Description
ResponseState ResponseState Value POSITIVE [0..1] This optional attribute determines whether a positive or negative response will be created. If the attribute is not set, the default value POSITIVE will apply implicitly.
Result Result Term - [1] The result the new response will be added to.

OTL Examples

/// Local Declarations

DiagCom.Result Result1;
DiagCom.Response Response1;

/// Flow

Response1 = Job.CreateResponse(Result1, @JobResponseStates:POSITIVE);

See also

CreateResult
GetJobInfo
GetJobProgress