org.ota.hotel
Class BookingRuleRS

java.lang.Object
  extended by org.ota.hotel.BookingRuleRS

public class BookingRuleRS
extends java.lang.Object

This message will provide the rule details for a specific hotel based on the room type, booking code, checkin/out dates or a confirmation number. Schema fragment(s) for this class:

 <xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="OTA_HotelBookingRuleRS">
   <xs:complexType>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
         <xs:element name="RuleMessage">
           <xs:complexType>
             <xs:sequence>
               <xs:element name="StatusApplication" minOccurs="0">
                 <!-- Reference to inner class StatusApplication -->
               </xs:element>
               <xs:element type="ns:GuestCountType" name="GuestCounts" minOccurs="0"/>
               <xs:element type="ns:BookingRulesType" name="BookingRules"/>
               <xs:element type="ns:ParagraphType" name="AdvisoryText" minOccurs="0"/>
               <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
             </xs:sequence>
             <xs:attributeGroup ref="ns:HotelReferenceGroup"/>
             <xs:attribute type="xs:string" use="optional" name="CurrencyCode"/>
             <xs:attribute type="xs:string" use="optional" name="InfoSource"/>
             <xs:attribute type="xs:string" use="optional" name="StateProv"/>
             <xs:attribute type="xs:string" use="optional" name="PostalCode"/>
             <xs:attribute type="xs:string" use="optional" name="Country"/>
             <xs:attribute type="xs:float" use="optional" name="CommissionPercent"/>
           </xs:complexType>
         </xs:element>
       </xs:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
   </xs:complexType>
 </xs:element>
 
 <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"/>
 


Nested Class Summary
static class BookingRuleRS.StatusApplication
          Specifies the check-in and check-out dates and the booking code or room type to which the booking rules apply.
 
Constructor Summary
BookingRuleRS()
           
 
Method Summary
 void clearChoiceSelect()
          Clear the choice selection.
 Errors getErrors()
          Get the 'Errors' element value.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup value.
 Paragraph getRuleMessageAdvisoryText()
          Get the 'AdvisoryText' element value.
 BookingRules getRuleMessageBookingRules()
          Get the 'BookingRules' element value.
 java.lang.Float getRuleMessageCommissionPercent()
          Get the 'CommissionPercent' attribute value.
 java.lang.String getRuleMessageCountry()
          Get the 'Country' attribute value.
 java.lang.String getRuleMessageCurrencyCode()
          Get the 'CurrencyCode' attribute value.
 GuestCount getRuleMessageGuestCounts()
          Get the 'GuestCounts' element value.
 HotelReferenceGroup getRuleMessageHotelReferenceGroup()
          Get the 'HotelReferenceGroup' attributeGroup value.
 java.lang.String getRuleMessageInfoSource()
          Get the 'InfoSource' attribute value.
 java.lang.String getRuleMessagePostalCode()
          Get the 'PostalCode' attribute value.
 java.lang.String getRuleMessageStateProv()
          Get the 'StateProv' attribute value.
 TPAExtensions getRuleMessageTPAExtensions()
          Get the 'TPA_Extensions' element value.
 BookingRuleRS.StatusApplication getStatusApplication()
          Get the 'StatusApplication' 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 setRuleMessageAdvisoryText(Paragraph ruleMessageAdvisoryText)
          Set the 'AdvisoryText' element value.
 void setRuleMessageBookingRules(BookingRules ruleMessageBookingRules)
          Set the 'BookingRules' element value.
 void setRuleMessageCommissionPercent(java.lang.Float ruleMessageCommissionPercent)
          Set the 'CommissionPercent' attribute value.
 void setRuleMessageCountry(java.lang.String ruleMessageCountry)
          Set the 'Country' attribute value.
 void setRuleMessageCurrencyCode(java.lang.String ruleMessageCurrencyCode)
          Set the 'CurrencyCode' attribute value.
 void setRuleMessageGuestCounts(GuestCount ruleMessageGuestCounts)
          Set the 'GuestCounts' element value.
 void setRuleMessageHotelReferenceGroup(HotelReferenceGroup ruleMessageHotelReferenceGroup)
          Set the 'HotelReferenceGroup' attributeGroup value.
 void setRuleMessageInfoSource(java.lang.String ruleMessageInfoSource)
          Set the 'InfoSource' attribute value.
 void setRuleMessagePostalCode(java.lang.String ruleMessagePostalCode)
          Set the 'PostalCode' attribute value.
 void setRuleMessageStateProv(java.lang.String ruleMessageStateProv)
          Set the 'StateProv' attribute value.
 void setRuleMessageTPAExtensions(TPAExtensions ruleMessageTPAExtensions)
          Set the 'TPA_Extensions' element value.
 void setStatusApplication(BookingRuleRS.StatusApplication statusApplication)
          Set the 'StatusApplication' 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

BookingRuleRS

public BookingRuleRS()
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 in conjunction with the Success element to define one or more business errors.

Returns:
value

setWarnings

public void setWarnings(Warnings warnings)
Set the 'Warnings' element value. Used in conjunction with the Success element to define one or more business errors.

Parameters:
warnings -

getStatusApplication

public BookingRuleRS.StatusApplication getStatusApplication()
Get the 'StatusApplication' element value. Specifies the hotel chain and property to which the booking rules apply.

Returns:
value

setStatusApplication

public void setStatusApplication(BookingRuleRS.StatusApplication statusApplication)
Set the 'StatusApplication' element value. Specifies the hotel chain and property to which the booking rules apply.

Parameters:
statusApplication -

getRuleMessageGuestCounts

public GuestCount getRuleMessageGuestCounts()
Get the 'GuestCounts' element value. Specifies the number of adults and children to which the booking rules apply.

Returns:
value

setRuleMessageGuestCounts

public void setRuleMessageGuestCounts(GuestCount ruleMessageGuestCounts)
Set the 'GuestCounts' element value. Specifies the number of adults and children to which the booking rules apply.

Parameters:
ruleMessageGuestCounts -

getRuleMessageBookingRules

public BookingRules getRuleMessageBookingRules()
Get the 'BookingRules' element value. A collection of booking rules.

Returns:
value

setRuleMessageBookingRules

public void setRuleMessageBookingRules(BookingRules ruleMessageBookingRules)
Set the 'BookingRules' element value. A collection of booking rules.

Parameters:
ruleMessageBookingRules -

getRuleMessageAdvisoryText

public Paragraph getRuleMessageAdvisoryText()
Get the 'AdvisoryText' element value. Advisory text related to the booking rules.

Returns:
value

setRuleMessageAdvisoryText

public void setRuleMessageAdvisoryText(Paragraph ruleMessageAdvisoryText)
Set the 'AdvisoryText' element value. Advisory text related to the booking rules.

Parameters:
ruleMessageAdvisoryText -

getRuleMessageTPAExtensions

public TPAExtensions getRuleMessageTPAExtensions()
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

setRuleMessageTPAExtensions

public void setRuleMessageTPAExtensions(TPAExtensions ruleMessageTPAExtensions)
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:
ruleMessageTPAExtensions -

getRuleMessageHotelReferenceGroup

public HotelReferenceGroup getRuleMessageHotelReferenceGroup()
Get the 'HotelReferenceGroup' attributeGroup value.

Returns:
value

setRuleMessageHotelReferenceGroup

public void setRuleMessageHotelReferenceGroup(HotelReferenceGroup ruleMessageHotelReferenceGroup)
Set the 'HotelReferenceGroup' attributeGroup value.

Parameters:
ruleMessageHotelReferenceGroup -

getRuleMessageCurrencyCode

public java.lang.String getRuleMessageCurrencyCode()
Get the 'CurrencyCode' attribute value.

Returns:
value

setRuleMessageCurrencyCode

public void setRuleMessageCurrencyCode(java.lang.String ruleMessageCurrencyCode)
Set the 'CurrencyCode' attribute value.

Parameters:
ruleMessageCurrencyCode -

getRuleMessageInfoSource

public java.lang.String getRuleMessageInfoSource()
Get the 'InfoSource' attribute value.

Returns:
value

setRuleMessageInfoSource

public void setRuleMessageInfoSource(java.lang.String ruleMessageInfoSource)
Set the 'InfoSource' attribute value.

Parameters:
ruleMessageInfoSource -

getRuleMessageStateProv

public java.lang.String getRuleMessageStateProv()
Get the 'StateProv' attribute value. The state code in which the hotel property is located.

Returns:
value

setRuleMessageStateProv

public void setRuleMessageStateProv(java.lang.String ruleMessageStateProv)
Set the 'StateProv' attribute value. The state code in which the hotel property is located.

Parameters:
ruleMessageStateProv -

getRuleMessagePostalCode

public java.lang.String getRuleMessagePostalCode()
Get the 'PostalCode' attribute value. The postal code (zip code) of the hotel property.

Returns:
value

setRuleMessagePostalCode

public void setRuleMessagePostalCode(java.lang.String ruleMessagePostalCode)
Set the 'PostalCode' attribute value. The postal code (zip code) of the hotel property.

Parameters:
ruleMessagePostalCode -

getRuleMessageCountry

public java.lang.String getRuleMessageCountry()
Get the 'Country' attribute value. The code of the country in which the hotel property is located.

Returns:
value

setRuleMessageCountry

public void setRuleMessageCountry(java.lang.String ruleMessageCountry)
Set the 'Country' attribute value. The code of the country in which the hotel property is located.

Parameters:
ruleMessageCountry -

getRuleMessageCommissionPercent

public java.lang.Float getRuleMessageCommissionPercent()
Get the 'CommissionPercent' attribute value. The commission percentage that applies to this hotel property.

Returns:
value

setRuleMessageCommissionPercent

public void setRuleMessageCommissionPercent(java.lang.Float ruleMessageCommissionPercent)
Set the 'CommissionPercent' attribute value. The commission percentage that applies to this hotel property.

Parameters:
ruleMessageCommissionPercent -

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. Errors are returned if the request was unable to be processed.

Returns:
value

setErrors

public void setErrors(Errors errors)
Set the 'Errors' element value. Errors are returned if the request was unable to be processed.

Parameters:
errors -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()
Get the 'OTA_PayloadStdAttributes' attributeGroup value.

Returns:
value

setOTAPayloadStdAttributes

public void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
Set the 'OTA_PayloadStdAttributes' attributeGroup value.

Parameters:
OTAPayloadStdAttributes -