org.ota.air
Class RulesRS

java.lang.Object
  extended by org.ota.air.RulesRS

public class RulesRS
extends java.lang.Object

The Rules Response message contains a set of text (human readable) rule information paragraphs. Each paragraph is identified by a rule code. This message contains similar information to a standard airline CRS or GDS Fare Rules Response message. 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_AirRulesRS">
   <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="FareRuleResponseInfo" minOccurs="0" maxOccurs="999">
           <!-- Reference to inner class FareRuleResponseInfo -->
         </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"/>
 


Nested Class Summary
static class RulesRS.FareRuleResponseInfo
          Provides fare rules and the applicable fare rule categories.
 
Constructor Summary
RulesRS()
           
 
Method Summary
 void addFareRuleResponseInfo(RulesRS.FareRuleResponseInfo item)
          Add a 'FareRuleResponseInfo' element item.
 void clearChoiceSelect()
          Clear the choice selection.
 void clearFareRuleResponseInfos()
          Remove all 'FareRuleResponseInfo' element items.
 Errors getErrors()
          Get the 'Errors' element value.
 RulesRS.FareRuleResponseInfo getFareRuleResponseInfo(int index)
          Get 'FareRuleResponseInfo' element item by position.
 java.util.List<RulesRS.FareRuleResponseInfo> getFareRuleResponseInfos()
          Get the list of 'FareRuleResponseInfo' element items.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup 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 setFareRuleResponseInfos(java.util.List<RulesRS.FareRuleResponseInfo> list)
          Set the list of 'FareRuleResponseInfo' element items.
 void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
          Set the 'OTA_PayloadStdAttributes' attributeGroup value.
 void setWarnings(Warnings warnings)
          Set the 'Warnings' element value.
 int sizeFareRuleResponseInfos()
          Get the number of 'FareRuleResponseInfo' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RulesRS

public RulesRS()
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. Standard way to indicate successful processing of an OpenTravel message, but one in which warnings are generated.

Returns:
value

setWarnings

public void setWarnings(Warnings warnings)
Set the 'Warnings' element value. Standard way to indicate successful processing of an OpenTravel message, but one in which warnings are generated.

Parameters:
warnings -

getFareRuleResponseInfos

public java.util.List<RulesRS.FareRuleResponseInfo> getFareRuleResponseInfos()
Get the list of 'FareRuleResponseInfo' element items.

Returns:
list

setFareRuleResponseInfos

public void setFareRuleResponseInfos(java.util.List<RulesRS.FareRuleResponseInfo> list)
Set the list of 'FareRuleResponseInfo' element items.

Parameters:
list -

sizeFareRuleResponseInfos

public int sizeFareRuleResponseInfos()
Get the number of 'FareRuleResponseInfo' element items.

Returns:
count

addFareRuleResponseInfo

public void addFareRuleResponseInfo(RulesRS.FareRuleResponseInfo item)
Add a 'FareRuleResponseInfo' element item.

Parameters:
item -

getFareRuleResponseInfo

public RulesRS.FareRuleResponseInfo getFareRuleResponseInfo(int index)
Get 'FareRuleResponseInfo' element item by position.

Parameters:
index -
Returns:
item

clearFareRuleResponseInfos

public void clearFareRuleResponseInfos()
Remove all 'FareRuleResponseInfo' element items.


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. A collection of errors that occurred during the processing of a message.

Returns:
value

setErrors

public void setErrors(Errors errors)
Set the 'Errors' element value. A collection of errors that occurred during the processing of a message.

Parameters:
errors -

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 -