Overview  Package   Class  Tree  Deprecated 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.ota.tour
Class SearchRQ

java.lang.Object
  extended by org.ota.tour.SearchRQ

public class SearchRQ
extends java.lang.Object

Allows a customer to search for tours matching specified criteria. 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_TourSearchRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" minOccurs="0"/>
       <xs:element name="SearchCriteria">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="SearchDateRange" minOccurs="0">
               <!-- Reference to inner class SearchDateRange -->
             </xs:element>
             <xs:element name="DestinationPref" minOccurs="0" maxOccurs="9">
               <!-- Reference to inner class DestinationPref -->
             </xs:element>
             <xs:element name="CategoryPref" minOccurs="0" maxOccurs="5">
               <!-- Reference to inner class CategoryPref -->
             </xs:element>
             <xs:element name="KeywordPref" minOccurs="0" maxOccurs="6">
               <!-- Reference to inner class KeywordPref -->
             </xs:element>
             <xs:element type="ns:CompanyNamePrefType" name="SupplierPref" minOccurs="0" maxOccurs="6"/>
             <xs:element name="CustomerCounts" minOccurs="0" maxOccurs="6">
               <xs:complexType>
                 <xs:attributeGroup ref="ns:TravelerCountGroup"/>
               </xs:complexType>
             </xs:element>
             <xs:element name="PricePref" minOccurs="0">
               <!-- Reference to inner class PricePref -->
             </xs:element>
             <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
           </xs:sequence>
           <xs:attribute type="xs:string" use="optional" name="MoreDataEchoToken"/>
         </xs:complexType>
       </xs:element>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:MaxResponsesGroup"/>
   </xs:complexType>
 </xs:element>
 
 <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"/>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="MaxResponsesGroup">
   <xs:attribute type="xs:string" use="optional" name="MaxResponses"/>
 </xs:attributeGroup>

Nested Class Summary
static class SearchRQ.CategoryPref
          Inidicates a preference for a category of tour.
static class SearchRQ.DestinationPref
          Up to 9 destinations to be included in or excluded from the search Schema fragment(s) for this class:
static class SearchRQ.KeywordPref
          Allows the inclusion or exclusion of keywords to be matched.
static class SearchRQ.PricePref
          Range or limit of budget.
static class SearchRQ.SearchDateRange
          The preferred start date and allowable time window for the search.
 
Constructor Summary
SearchRQ()
           
 
Method Summary
 void addCategoryPref(SearchRQ.CategoryPref item)
          Add a 'CategoryPref' element item.
 void addDestinationPref(SearchRQ.DestinationPref item)
          Add a 'DestinationPref' element item.
 void addKeywordPref(SearchRQ.KeywordPref item)
          Add a 'KeywordPref' element item.
 void addSearchCriteriaCustomerCount(TravelerCountGroup item)
          Add a 'CustomerCounts' element item.
 void addSearchCriteriaSupplierPref(CompanyNamePref item)
          Add a 'SupplierPref' element item.
 void clearCategoryPrefs()
          Remove all 'CategoryPref' element items.
 void clearDestinationPrefs()
          Remove all 'DestinationPref' element items.
 void clearKeywordPrefs()
          Remove all 'KeywordPref' element items.
 void clearSearchCriteriaCustomerCounts()
          Remove all 'CustomerCounts' element items.
 void clearSearchCriteriaSupplierPrefs()
          Remove all 'SupplierPref' element items.
 SearchRQ.CategoryPref getCategoryPref(int index)
          Get 'CategoryPref' element item by position.
 java.util.List<SearchRQ.CategoryPref> getCategoryPrefs()
          Get the list of 'CategoryPref' element items.
 SearchRQ.DestinationPref getDestinationPref(int index)
          Get 'DestinationPref' element item by position.
 java.util.List<SearchRQ.DestinationPref> getDestinationPrefs()
          Get the list of 'DestinationPref' element items.
 SearchRQ.KeywordPref getKeywordPref(int index)
          Get 'KeywordPref' element item by position.
 java.util.List<SearchRQ.KeywordPref> getKeywordPrefs()
          Get the list of 'KeywordPref' element items.
 java.lang.String getMaxResponses()
          Get the 'MaxResponses' attribute value.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup value.
 POS getPOS()
          Get the 'POS' element value.
 SearchRQ.PricePref getPricePref()
          Get the 'PricePref' element value.
 TravelerCountGroup getSearchCriteriaCustomerCount(int index)
          Get 'CustomerCounts' element item by position.
 java.util.List<TravelerCountGroup> getSearchCriteriaCustomerCounts()
          Get the list of 'CustomerCounts' element items.
 java.lang.String getSearchCriteriaMoreDataEchoToken()
          Get the 'MoreDataEchoToken' attribute value.
 CompanyNamePref getSearchCriteriaSupplierPref(int index)
          Get 'SupplierPref' element item by position.
 java.util.List<CompanyNamePref> getSearchCriteriaSupplierPrefs()
          Get the list of 'SupplierPref' element items.
 TPAExtensions getSearchCriteriaTPAExtensions()
          Get the 'TPA_Extensions' element value.
 SearchRQ.SearchDateRange getSearchDateRange()
          Get the 'SearchDateRange' element value.
 void setCategoryPrefs(java.util.List<SearchRQ.CategoryPref> list)
          Set the list of 'CategoryPref' element items.
 void setDestinationPrefs(java.util.List<SearchRQ.DestinationPref> list)
          Set the list of 'DestinationPref' element items.
 void setKeywordPrefs(java.util.List<SearchRQ.KeywordPref> list)
          Set the list of 'KeywordPref' element items.
 void setMaxResponses(java.lang.String maxResponses)
          Set the 'MaxResponses' attribute value.
 void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
          Set the 'OTA_PayloadStdAttributes' attributeGroup value.
 void setPOS(POS POS)
          Set the 'POS' element value.
 void setPricePref(SearchRQ.PricePref pricePref)
          Set the 'PricePref' element value.
 void setSearchCriteriaCustomerCounts(java.util.List<TravelerCountGroup> list)
          Set the list of 'CustomerCounts' element items.
 void setSearchCriteriaMoreDataEchoToken(java.lang.String searchCriteriaMoreDataEchoToken)
          Set the 'MoreDataEchoToken' attribute value.
 void setSearchCriteriaSupplierPrefs(java.util.List<CompanyNamePref> list)
          Set the list of 'SupplierPref' element items.
 void setSearchCriteriaTPAExtensions(TPAExtensions searchCriteriaTPAExtensions)
          Set the 'TPA_Extensions' element value.
 void setSearchDateRange(SearchRQ.SearchDateRange searchDateRange)
          Set the 'SearchDateRange' element value.
 int sizeCategoryPrefs()
          Get the number of 'CategoryPref' element items.
 int sizeDestinationPrefs()
          Get the number of 'DestinationPref' element items.
 int sizeKeywordPrefs()
          Get the number of 'KeywordPref' element items.
 int sizeSearchCriteriaCustomerCounts()
          Get the number of 'CustomerCounts' element items.
 int sizeSearchCriteriaSupplierPrefs()
          Get the number of 'SupplierPref' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchRQ

public SearchRQ()
Method Detail

getPOS

public POS getPOS()
Get the 'POS' element value. The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner that is sending the request or the response message.

Returns:
value

setPOS

public void setPOS(POS POS)
Set the 'POS' element value. The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner that is sending the request or the response message.

Parameters:
POS -

getSearchDateRange

public SearchRQ.SearchDateRange getSearchDateRange()
Get the 'SearchDateRange' element value. Collection of items for data from multiple tours.

Returns:
value

setSearchDateRange

public void setSearchDateRange(SearchRQ.SearchDateRange searchDateRange)
Set the 'SearchDateRange' element value. Collection of items for data from multiple tours.

Parameters:
searchDateRange -

getDestinationPrefs

public java.util.List<SearchRQ.DestinationPref> getDestinationPrefs()
Get the list of 'DestinationPref' element items. Collection of items for data from multiple tours.

Returns:
list

setDestinationPrefs

public void setDestinationPrefs(java.util.List<SearchRQ.DestinationPref> list)
Set the list of 'DestinationPref' element items. Collection of items for data from multiple tours.

Parameters:
list -

sizeDestinationPrefs

public int sizeDestinationPrefs()
Get the number of 'DestinationPref' element items.

Returns:
count

addDestinationPref

public void addDestinationPref(SearchRQ.DestinationPref item)
Add a 'DestinationPref' element item.

Parameters:
item -

getDestinationPref

public SearchRQ.DestinationPref getDestinationPref(int index)
Get 'DestinationPref' element item by position.

Parameters:
index -
Returns:
item

clearDestinationPrefs

public void clearDestinationPrefs()
Remove all 'DestinationPref' element items.

getCategoryPrefs

public java.util.List<SearchRQ.CategoryPref> getCategoryPrefs()
Get the list of 'CategoryPref' element items. Collection of items for data from multiple tours.

Returns:
list

setCategoryPrefs

public void setCategoryPrefs(java.util.List<SearchRQ.CategoryPref> list)
Set the list of 'CategoryPref' element items. Collection of items for data from multiple tours.

Parameters:
list -

sizeCategoryPrefs

public int sizeCategoryPrefs()
Get the number of 'CategoryPref' element items.

Returns:
count

addCategoryPref

public void addCategoryPref(SearchRQ.CategoryPref item)
Add a 'CategoryPref' element item.

Parameters:
item -

getCategoryPref

public SearchRQ.CategoryPref getCategoryPref(int index)
Get 'CategoryPref' element item by position.

Parameters:
index -
Returns:
item

clearCategoryPrefs

public void clearCategoryPrefs()
Remove all 'CategoryPref' element items.

getKeywordPrefs

public java.util.List<SearchRQ.KeywordPref> getKeywordPrefs()
Get the list of 'KeywordPref' element items. Collection of items for data from multiple tours.

Returns:
list

setKeywordPrefs

public void setKeywordPrefs(java.util.List<SearchRQ.KeywordPref> list)
Set the list of 'KeywordPref' element items. Collection of items for data from multiple tours.

Parameters:
list -

sizeKeywordPrefs

public int sizeKeywordPrefs()
Get the number of 'KeywordPref' element items.

Returns:
count

addKeywordPref

public void addKeywordPref(SearchRQ.KeywordPref item)
Add a 'KeywordPref' element item.

Parameters:
item -

getKeywordPref

public SearchRQ.KeywordPref getKeywordPref(int index)
Get 'KeywordPref' element item by position.

Parameters:
index -
Returns:
item

clearKeywordPrefs

public void clearKeywordPrefs()
Remove all 'KeywordPref' element items.

getSearchCriteriaSupplierPrefs

public java.util.List<CompanyNamePref> getSearchCriteriaSupplierPrefs()
Get the list of 'SupplierPref' element items. Allows the inclusion or exclusion of a supplier.

Returns:
list

setSearchCriteriaSupplierPrefs

public void setSearchCriteriaSupplierPrefs(java.util.List<CompanyNamePref> list)
Set the list of 'SupplierPref' element items. Allows the inclusion or exclusion of a supplier.

Parameters:
list -

sizeSearchCriteriaSupplierPrefs

public int sizeSearchCriteriaSupplierPrefs()
Get the number of 'SupplierPref' element items.

Returns:
count

addSearchCriteriaSupplierPref

public void addSearchCriteriaSupplierPref(CompanyNamePref item)
Add a 'SupplierPref' element item.

Parameters:
item -

getSearchCriteriaSupplierPref

public CompanyNamePref getSearchCriteriaSupplierPref(int index)
Get 'SupplierPref' element item by position.

Parameters:
index -
Returns:
item

clearSearchCriteriaSupplierPrefs

public void clearSearchCriteriaSupplierPrefs()
Remove all 'SupplierPref' element items.

getSearchCriteriaCustomerCounts

public java.util.List<TravelerCountGroup> getSearchCriteriaCustomerCounts()
Get the list of 'CustomerCounts' element items. Specifies the number of customers and optionally by customer type.

Returns:
list

setSearchCriteriaCustomerCounts

public void setSearchCriteriaCustomerCounts(java.util.List<TravelerCountGroup> list)
Set the list of 'CustomerCounts' element items. Specifies the number of customers and optionally by customer type.

Parameters:
list -

sizeSearchCriteriaCustomerCounts

public int sizeSearchCriteriaCustomerCounts()
Get the number of 'CustomerCounts' element items.

Returns:
count

addSearchCriteriaCustomerCount

public void addSearchCriteriaCustomerCount(TravelerCountGroup item)
Add a 'CustomerCounts' element item.

Parameters:
item -

getSearchCriteriaCustomerCount

public TravelerCountGroup getSearchCriteriaCustomerCount(int index)
Get 'CustomerCounts' element item by position.

Parameters:
index -
Returns:
item

clearSearchCriteriaCustomerCounts

public void clearSearchCriteriaCustomerCounts()
Remove all 'CustomerCounts' element items.

getPricePref

public SearchRQ.PricePref getPricePref()
Get the 'PricePref' element value. Collection of items for data from multiple tours.

Returns:
value

setPricePref

public void setPricePref(SearchRQ.PricePref pricePref)
Set the 'PricePref' element value. Collection of items for data from multiple tours.

Parameters:
pricePref -

getSearchCriteriaTPAExtensions

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

setSearchCriteriaTPAExtensions

public void setSearchCriteriaTPAExtensions(TPAExtensions searchCriteriaTPAExtensions)
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:
searchCriteriaTPAExtensions -

getSearchCriteriaMoreDataEchoToken

public java.lang.String getSearchCriteriaMoreDataEchoToken()
Get the 'MoreDataEchoToken' attribute value. The response returns the attribute if there was additional data. The text value should be echoed in this request to indicate where to begin the next block of data.

Returns:
value

setSearchCriteriaMoreDataEchoToken

public void setSearchCriteriaMoreDataEchoToken(java.lang.String searchCriteriaMoreDataEchoToken)
Set the 'MoreDataEchoToken' attribute value. The response returns the attribute if there was additional data. The text value should be echoed in this request to indicate where to begin the next block of data.

Parameters:
searchCriteriaMoreDataEchoToken -

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 -

getMaxResponses

public java.lang.String getMaxResponses()
Get the 'MaxResponses' attribute value. A positive integer value that indicates the maximum number of responses desired in the return.

Returns:
value

setMaxResponses

public void setMaxResponses(java.lang.String maxResponses)
Set the 'MaxResponses' attribute value. A positive integer value that indicates the maximum number of responses desired in the return.

Parameters:
maxResponses -
Overview  Package   Class  Tree  Deprecated 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD