org.ota.shared
Class OTAPayloadStdAttributes

java.lang.Object
  org.ota.shared.OTAPayloadStdAttributes

Direct Known Subclasses:

DestActivityCapabilitiesRQ

public class OTAPayloadStdAttributes
extends java.lang.Object

The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel messages. Schema fragment(s) for this class:

 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="OTA_PayloadStdAttributes">
   <xs:attribute type="xs:string" use="optional" name="EchoToken"/>
   <xs:attribute type="xs:dateTime" use="optional" name="TimeStamp"/>
   <xs:attribute use="optional" name="Target">
     <xs:simpleType>
       <!-- Reference to inner class Target -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute type="xs:float" use="required" name="Version"/>
   <xs:attribute type="xs:string" use="optional" name="TransactionIdentifier"/>
   <xs:attribute type="xs:int" use="optional" name="SequenceNmbr"/>
   <xs:attribute use="optional" name="TransactionStatusCode">
     <xs:simpleType>
       <!-- Reference to inner class TransactionStatusCode -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attributeGroup ref="ns:PrimaryLangID_Group"/>
   <xs:attributeGroup ref="ns:AltLangID_Group"/>
   <xs:attribute type="xs:boolean" use="optional" name="RetransmissionIndicator"/>
   <xs:attribute type="xs:string" use="optional" name="CorrelationID"/>
 </xs:attributeGroup>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PrimaryLangID_Group">
   <xs:attribute type="xs:string" use="optional" name="PrimaryLangID"/>
 </xs:attributeGroup>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="AltLangID_Group">
   <xs:attribute type="xs:string" use="optional" name="AltLangID"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class	OTAPayloadStdAttributes.Target Schema fragment(s) for this class:
static class	OTAPayloadStdAttributes.TransactionStatusCode Schema fragment(s) for this class:

Constructor Summary

OTAPayloadStdAttributes()

Method Summary

java.lang.String	getAltLangID() Get the 'AltLangID' attribute value.
java.lang.String	getCorrelationID() Get the 'CorrelationID' attribute value.
java.lang.String	getEchoToken() Get the 'EchoToken' attribute value.
java.lang.String	getPrimaryLangID() Get the 'PrimaryLangID' attribute value.
java.lang.Boolean	getRetransmissionIndicator() Get the 'RetransmissionIndicator' attribute value.
java.lang.Integer	getSequenceNmbr() Get the 'SequenceNmbr' attribute value.
OTAPayloadStdAttributes.Target	getTarget() Get the 'Target' attribute value.
java.util.Date	getTimeStamp() Get the 'TimeStamp' attribute value.
java.lang.String	getTransactionIdentifier() Get the 'TransactionIdentifier' attribute value.
OTAPayloadStdAttributes.TransactionStatusCode	getTransactionStatusCode() Get the 'TransactionStatusCode' attribute value.
java.lang.Float	getVersion() Get the 'Version' attribute value.
void	setAltLangID(java.lang.String altLangID) Set the 'AltLangID' attribute value.
void	setCorrelationID(java.lang.String correlationID) Set the 'CorrelationID' attribute value.
void	setEchoToken(java.lang.String echoToken) Set the 'EchoToken' attribute value.
void	setPrimaryLangID(java.lang.String primaryLangID) Set the 'PrimaryLangID' attribute value.
void	setRetransmissionIndicator(java.lang.Boolean retransmissionIndicator) Set the 'RetransmissionIndicator' attribute value.
void	setSequenceNmbr(java.lang.Integer sequenceNmbr) Set the 'SequenceNmbr' attribute value.
void	setTarget(OTAPayloadStdAttributes.Target target) Set the 'Target' attribute value.
void	setTimeStamp(java.util.Date timeStamp) Set the 'TimeStamp' attribute value.
void	setTransactionIdentifier(java.lang.String transactionIdentifier) Set the 'TransactionIdentifier' attribute value.
void	setTransactionStatusCode(OTAPayloadStdAttributes.TransactionStatusCode transactionStatusCode) Set the 'TransactionStatusCode' attribute value.
void	setVersion(java.lang.Float version) Set the 'Version' attribute value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OTAPayloadStdAttributes

public OTAPayloadStdAttributes()

Method Detail

getEchoToken

public java.lang.String getEchoToken()

Get the 'EchoToken' attribute value. A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

Returns:

value

setEchoToken

public void setEchoToken(java.lang.String echoToken)

Set the 'EchoToken' attribute value. A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

Parameters:

echoToken -

getTimeStamp

public java.util.Date getTimeStamp()

Get the 'TimeStamp' attribute value. Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

Returns:

value

setTimeStamp

public void setTimeStamp(java.util.Date timeStamp)

Set the 'TimeStamp' attribute value. Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

Parameters:

timeStamp -

getTarget

public OTAPayloadStdAttributes.Target getTarget()

Get the 'Target' attribute value. Used to indicate whether the request is for the Test or Production system. Production

Returns:

value

setTarget

public void setTarget(OTAPayloadStdAttributes.Target target)

Set the 'Target' attribute value. Used to indicate whether the request is for the Test or Production system. Production

Parameters:

target -

getVersion

public java.lang.Float getVersion()

Get the 'Version' attribute value. For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.

Returns:

value

setVersion

public void setVersion(java.lang.Float version)

Set the 'Version' attribute value. For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.

Parameters:

version -

getTransactionIdentifier

public java.lang.String getTransactionIdentifier()

Get the 'TransactionIdentifier' attribute value. A unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).

Returns:

value

setTransactionIdentifier

public void setTransactionIdentifier(java.lang.String transactionIdentifier)

Set the 'TransactionIdentifier' attribute value. A unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).

Parameters:

transactionIdentifier -

getSequenceNmbr

public java.lang.Integer getSequenceNmbr()

Get the 'SequenceNmbr' attribute value. Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages in the event that a system has been off-line and needs to retrieve messages that were missed.

Returns:

value

setSequenceNmbr

public void setSequenceNmbr(java.lang.Integer sequenceNmbr)

Set the 'SequenceNmbr' attribute value. Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages in the event that a system has been off-line and needs to retrieve messages that were missed.

Parameters:

sequenceNmbr -

getTransactionStatusCode

public OTAPayloadStdAttributes.TransactionStatusCode getTransactionStatusCode()

Get the 'TransactionStatusCode' attribute value. This indicates where this message falls within a sequence of messages.

Returns:

value

setTransactionStatusCode

public void setTransactionStatusCode(OTAPayloadStdAttributes.TransactionStatusCode transactionStatusCode)

Set the 'TransactionStatusCode' attribute value. This indicates where this message falls within a sequence of messages.

Parameters:

transactionStatusCode -

getPrimaryLangID

public java.lang.String getPrimaryLangID()

Get the 'PrimaryLangID' attribute value. Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.

Returns:

value

setPrimaryLangID

public void setPrimaryLangID(java.lang.String primaryLangID)

Set the 'PrimaryLangID' attribute value. Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.

Parameters:

primaryLangID -

getAltLangID

public java.lang.String getAltLangID()

Get the 'AltLangID' attribute value. Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.

Returns:

value

setAltLangID

public void setAltLangID(java.lang.String altLangID)

Set the 'AltLangID' attribute value. Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.

Parameters:

altLangID -

getRetransmissionIndicator

public java.lang.Boolean getRetransmissionIndicator()

Get the 'RetransmissionIndicator' attribute value. When true, indicates the message is being re-sent after a failure. It is recommended that this attribute is used (i.e., set to TRUE) only when a message is retransmitted.

Returns:

value

setRetransmissionIndicator

public void setRetransmissionIndicator(java.lang.Boolean retransmissionIndicator)

Set the 'RetransmissionIndicator' attribute value. When true, indicates the message is being re-sent after a failure. It is recommended that this attribute is used (i.e., set to TRUE) only when a message is retransmitted.

Parameters:

retransmissionIndicator -

getCorrelationID

public java.lang.String getCorrelationID()

Get the 'CorrelationID' attribute value. Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Returns:

value

setCorrelationID

public void setCorrelationID(java.lang.String correlationID)

Set the 'CorrelationID' attribute value. Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Parameters:

correlationID -