org.ota.shared
Class MessageAcknowledgement

java.lang.Object
  extended by org.ota.shared.MessageAcknowledgement
Direct Known Subclasses:
AvailNotifRS, BookingRuleNotifRS, CommNotifRS, DescriptiveContentNotifRS, FileAttachmentNotifRS, InformationNotifRS, InvCountNotifRS, ModifyNotifRS, NotifReportRQ, NotifReportRS, PostEventNotifRS, RateAmountNotifRS, RateNotifRS, RateRuleNotifRS, StatsNotifRS, SummaryNotifRS

public class MessageAcknowledgement
extends java.lang.Object

Information to acknowledge the receipt of a message. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="MessageAcknowledgementType">
   <xs:sequence>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
       </xs:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:element type="ns:UniqueID_Type" name="UniqueID" minOccurs="0"/>
     <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
   </xs:sequence>
   <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
 </xs:complexType>
 
 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="SuccessType"/>
 
 <xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" type="ns:TPA_ExtensionsType" name="TPA_Extensions"/>
 


Constructor Summary
MessageAcknowledgement()
           
 
Method Summary
 void clearChoiceSelect()
          Clear the choice selection.
 Errors getErrors()
          Get the 'Errors' element value.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup value.
 TPAExtensions getTPAExtensions()
          Get the 'TPA_Extensions' element value.
 UniqueID getUniqueID()
          Get the 'UniqueID' element value.
 Warnings getWarnings()
          Get the 'Warnings' element value.
 boolean ifErrors()
          Check if Errors is current selection for choice.
 boolean ifSuccess()
          Check if Success is current selection for choice.
 void setErrors(Errors errors)
          Set the 'Errors' element value.
 void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
          Set the 'OTA_PayloadStdAttributes' attributeGroup value.
 void setTPAExtensions(TPAExtensions TPAExtensions)
          Set the 'TPA_Extensions' element value.
 void setUniqueID(UniqueID uniqueID)
          Set the 'UniqueID' element value.
 void setWarnings(Warnings warnings)
          Set the 'Warnings' element value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageAcknowledgement

public MessageAcknowledgement()
Method Detail

clearChoiceSelect

public void clearChoiceSelect()
Clear the choice selection.


ifSuccess

public boolean ifSuccess()
Check if Success is current selection for choice.

Returns:
true if selection, false if not

getWarnings

public Warnings getWarnings()
Get the 'Warnings' element value. Used when a message has been successfully processed to report any warnings or business errors that occurred.

Returns:
value

setWarnings

public void setWarnings(Warnings warnings)
Set the 'Warnings' element value. Used when a message has been successfully processed to report any warnings or business errors that occurred.

Parameters:
warnings -

ifErrors

public boolean ifErrors()
Check if Errors is current selection for choice.

Returns:
true if selection, false if not

getErrors

public Errors getErrors()
Get the 'Errors' element value. Indicates an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.

Returns:
value

setErrors

public void setErrors(Errors errors)
Set the 'Errors' element value. Indicates an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.

Parameters:
errors -

getUniqueID

public UniqueID getUniqueID()
Get the 'UniqueID' element value. May be used to return the unique id from the request message.

Returns:
value

setUniqueID

public void setUniqueID(UniqueID uniqueID)
Set the 'UniqueID' element value. May be used to return the unique id from the request message.

Parameters:
uniqueID -

getTPAExtensions

public TPAExtensions getTPAExtensions()
Get the 'TPA_Extensions' element value. A placeholder in the schema to allow for additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).

Returns:
value

setTPAExtensions

public void setTPAExtensions(TPAExtensions TPAExtensions)
Set the 'TPA_Extensions' element value. A placeholder in the schema to allow for additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).

Parameters:
TPAExtensions -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()
Get the 'OTA_PayloadStdAttributes' attributeGroup value. The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages.

Returns:
value

setOTAPayloadStdAttributes

public void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
Set the 'OTA_PayloadStdAttributes' attributeGroup value. The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages.

Parameters:
OTAPayloadStdAttributes -