txControlResponseType

 Top  Previous  Next

txControlResponseType is a complex type. It is a sequence of three elements, all of which occur exactly once and in the order shown.

 

<header-or-parameter-name xmlns="http://soapam.com/types/">

<txURL> </txURL>

<txOutcome> </txOutcome>

<txResult> </txResult>

</header-or-parameter-name>

 

A header or parameter of type txControlResponseType is included in responses from methods whose definitions include a <transactionControl> element with its clientControl attribute set to "1". An element of type txControlResponseType is also returned from the built-in TransactionControl service's BeginTransaction, CommitTransaction and AbortTransaction methods.

 

See Client Transaction Control for more information.

 

element name

content data type

usage

default value

description

 

txURL

xsd:string

required

 

   A transaction URL which uniquely identifies the transaction. If the requested transaction control operation was to begin a new transaction, txURL is the new transaction identifier. Otherwise, it is the same transaction identifier specified in the request.

 

txOutcome

txOutcomeEnum

required

 

  One of: "suspended", "committed", "aborted" or "unknown" indicating the outcome of the transaction control operation.

 

txResult

xsd:int

required

0

   The result code (file system error number) of the NSK transaction control API, e.g. ENDTRANSACTION() used by SOAP/AM Server to execute the requested transaction control operation. If non-zero, the status of the transaction is "unknown" as indicated by txOutcome.

Remarks

Always examine the txResult element contained in the response. If non-zero, the status of the transaction is unknown.

Example

txControlResponseType as header in SOAP response

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP-ENV:Header>

       <txControlResponse xmlns="http://soapam.com/types/">

         <txURL>soapamtx://\MYSYS.0.12345678</txURL>

         <txOutcome>committed</txOutcome>

         <txResult>0</txResult>

       </txControlResponse>

   </SOAP-ENV:Header>

   <SOAP-ENV:Body>

... detail omitted ...

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>