org.ota.cruise
Class SearchQualifier

java.lang.Object
  org.ota.cruise.SearchQualifier

Direct Known Subclasses:

CabinAvailRQ.SearchQualifiers, CabinHoldRQ.SearchQualifiers, CategoryAvailRQ.SearchQualifiers, SailingSearchQualifier

public class SearchQualifier
extends java.lang.Object

Search qualifiers that can be used in cruise availability/fare/category to avail special search data. 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="SearchQualifierType">
   <xs:sequence>
     <xs:element type="ns:UniqueID_Type" name="ReservationID" minOccurs="0"/>
     <xs:element name="Residency" minOccurs="0">
       <!-- Reference to inner class Residency -->
     </xs:element>
     <xs:element name="PriceRange" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:RateRangeGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="Status" minOccurs="0" maxOccurs="5">
       <!-- Reference to inner class Status -->
     </xs:element>
     <xs:element name="Dining" minOccurs="0">
       <!-- Reference to inner class Dining -->
     </xs:element>
   </xs:sequence>
   <xs:attributeGroup ref="ns:CruiseCategoryGroup"/>
   <xs:attribute type="xs:string" use="optional" name="CabinNumber"/>
   <xs:attribute type="xs:boolean" use="optional" name="HeldIndicator"/>
   <xs:attributeGroup ref="ns:FareGroup"/>
   <xs:attribute type="xs:int" use="optional" name="MaxOccupancy"/>
   <xs:attribute type="ns:CategoryLocationType" use="optional" name="CategoryLocation"/>
   <xs:attributeGroup ref="ns:LoyaltyInfoGroup"/>
   <xs:attribute type="xs:string" use="optional" name="SortOrderCode"/>
 </xs:complexType>
 

Nested Class Summary

static class	SearchQualifier.Dining Provides a search filter by dining sitting.
static class	SearchQualifier.Residency Defines where the passenger resides for fare calculation purposes.
static class	SearchQualifier.Status Provides a search filter by the status of sailing, category, fare, or cabin.

Constructor Summary

SearchQualifier()

Method Summary

void	addStatu(SearchQualifier.Status item) Add a 'Status' element item.
void	clearStatus() Remove all 'Status' element items.
java.lang.String	getCabinNumber() Get the 'CabinNumber' attribute value.
CategoryLocation	getCategoryLocation() Get the 'CategoryLocation' attribute value.
CruiseCategoryGroup	getCruiseCategoryGroup() Get the 'CruiseCategoryGroup' attributeGroup value.
SearchQualifier.Dining	getDining() Get the 'Dining' element value.
FareGroup	getFareGroup() Get the 'FareGroup' attributeGroup value.
java.lang.Boolean	getHeldIndicator() Get the 'HeldIndicator' attribute value.
LoyaltyInfoGroup	getLoyaltyInfoGroup() Get the 'LoyaltyInfoGroup' attributeGroup value.
java.lang.Integer	getMaxOccupancy() Get the 'MaxOccupancy' attribute value.
RateRangeGroup	getPriceRange() Get the 'RateRangeGroup' attributeGroup value.
UniqueID	getReservationID() Get the 'ReservationID' element value.
SearchQualifier.Residency	getResidency() Get the 'Residency' element value.
java.lang.String	getSortOrderCode() Get the 'SortOrderCode' attribute value.
SearchQualifier.Status	getStatu(int index) Get 'Status' element item by position.
java.util.List<SearchQualifier.Status>	getStatus() Get the list of 'Status' element items.
void	setCabinNumber(java.lang.String cabinNumber) Set the 'CabinNumber' attribute value.
void	setCategoryLocation(CategoryLocation categoryLocation) Set the 'CategoryLocation' attribute value.
void	setCruiseCategoryGroup(CruiseCategoryGroup cruiseCategoryGroup) Set the 'CruiseCategoryGroup' attributeGroup value.
void	setDining(SearchQualifier.Dining dining) Set the 'Dining' element value.
void	setFareGroup(FareGroup fareGroup) Set the 'FareGroup' attributeGroup value.
void	setHeldIndicator(java.lang.Boolean heldIndicator) Set the 'HeldIndicator' attribute value.
void	setLoyaltyInfoGroup(LoyaltyInfoGroup loyaltyInfoGroup) Set the 'LoyaltyInfoGroup' attributeGroup value.
void	setMaxOccupancy(java.lang.Integer maxOccupancy) Set the 'MaxOccupancy' attribute value.
void	setPriceRange(RateRangeGroup priceRange) Set the 'RateRangeGroup' attributeGroup value.
void	setReservationID(UniqueID reservationID) Set the 'ReservationID' element value.
void	setResidency(SearchQualifier.Residency residency) Set the 'Residency' element value.
void	setSortOrderCode(java.lang.String sortOrderCode) Set the 'SortOrderCode' attribute value.
void	setStatus(java.util.List<SearchQualifier.Status> list) Set the list of 'Status' element items.
int	sizeStatus() Get the number of 'Status' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchQualifier

public SearchQualifier()

Method Detail

getReservationID

public UniqueID getReservationID()

Get the 'ReservationID' element value. Specifies the passenger's reservation number.

Returns:

value

setReservationID

public void setReservationID(UniqueID reservationID)

Set the 'ReservationID' element value. Specifies the passenger's reservation number.

Parameters:

reservationID -

getResidency

public SearchQualifier.Residency getResidency()

Get the 'Residency' element value.

Returns:

value

setResidency

public void setResidency(SearchQualifier.Residency residency)

Set the 'Residency' element value.

Parameters:

residency -

getPriceRange

public RateRangeGroup getPriceRange()

Get the 'RateRangeGroup' attributeGroup value. Provides a minimum and maximum price to qualify a search.

Returns:

value

setPriceRange

public void setPriceRange(RateRangeGroup priceRange)

Set the 'RateRangeGroup' attributeGroup value. Provides a minimum and maximum price to qualify a search.

Parameters:

priceRange -

getStatus

public java.util.List<SearchQualifier.Status> getStatus()

Get the list of 'Status' element items.

Returns:

list

setStatus

public void setStatus(java.util.List<SearchQualifier.Status> list)

Set the list of 'Status' element items.

Parameters:

list -

sizeStatus

public int sizeStatus()

Get the number of 'Status' element items.

Returns:

count

addStatu

public void addStatu(SearchQualifier.Status item)

Add a 'Status' element item.

Parameters:

item -

getStatu

public SearchQualifier.Status getStatu(int index)

Get 'Status' element item by position.

Parameters:

index -

Returns:

item

clearStatus

public void clearStatus()

Remove all 'Status' element items.

getDining

public SearchQualifier.Dining getDining()

Get the 'Dining' element value.

Returns:

value

setDining

public void setDining(SearchQualifier.Dining dining)

Set the 'Dining' element value.

Parameters:

dining -

getCruiseCategoryGroup

public CruiseCategoryGroup getCruiseCategoryGroup()

Get the 'CruiseCategoryGroup' attributeGroup value. Contains the berth and price category codes.

Returns:

value

setCruiseCategoryGroup

public void setCruiseCategoryGroup(CruiseCategoryGroup cruiseCategoryGroup)

Set the 'CruiseCategoryGroup' attributeGroup value. Contains the berth and price category codes.

Parameters:

cruiseCategoryGroup -

getCabinNumber

public java.lang.String getCabinNumber()

Get the 'CabinNumber' attribute value. Specifies the cabin number.

Returns:

value

setCabinNumber

public void setCabinNumber(java.lang.String cabinNumber)

Set the 'CabinNumber' attribute value. Specifies the cabin number.

Parameters:

cabinNumber -

getHeldIndicator

public java.lang.Boolean getHeldIndicator()

Get the 'HeldIndicator' attribute value. When true, indicates the CabinNumber has a hold on it. When false, the CabinNumber does not have a hold.

Returns:

value

setHeldIndicator

public void setHeldIndicator(java.lang.Boolean heldIndicator)

Set the 'HeldIndicator' attribute value. When true, indicates the CabinNumber has a hold on it. When false, the CabinNumber does not have a hold.

Parameters:

heldIndicator -

getFareGroup

public FareGroup getFareGroup()

Get the 'FareGroup' attributeGroup value. Specifies the fare and group codes.

Returns:

value

setFareGroup

public void setFareGroup(FareGroup fareGroup)

Set the 'FareGroup' attributeGroup value. Specifies the fare and group codes.

Parameters:

fareGroup -

getMaxOccupancy

public java.lang.Integer getMaxOccupancy()

Get the 'MaxOccupancy' attribute value. Specifies the Max occupancy of the Cabin

Returns:

value

setMaxOccupancy

public void setMaxOccupancy(java.lang.Integer maxOccupancy)

Set the 'MaxOccupancy' attribute value. Specifies the Max occupancy of the Cabin

Parameters:

maxOccupancy -

getCategoryLocation

public CategoryLocation getCategoryLocation()

Get the 'CategoryLocation' attribute value. Specifies the cabin category location (e.g., inside, outside).

Returns:

value

setCategoryLocation

public void setCategoryLocation(CategoryLocation categoryLocation)

Set the 'CategoryLocation' attribute value. Specifies the cabin category location (e.g., inside, outside).

Parameters:

categoryLocation -

getLoyaltyInfoGroup

public LoyaltyInfoGroup getLoyaltyInfoGroup()

Get the 'LoyaltyInfoGroup' attributeGroup value. Identifies the loyalty membership of a guest or prospect.

Returns:

value

setLoyaltyInfoGroup

public void setLoyaltyInfoGroup(LoyaltyInfoGroup loyaltyInfoGroup)

Set the 'LoyaltyInfoGroup' attributeGroup value. Identifies the loyalty membership of a guest or prospect.

Parameters:

loyaltyInfoGroup -

getSortOrderCode

public java.lang.String getSortOrderCode()

Get the 'SortOrderCode' attribute value. Specifies the order in which the response information should be sorted. Refer to OpenTravel Code List Sort Order (SOC).

Returns:

value

setSortOrderCode

public void setSortOrderCode(java.lang.String sortOrderCode)

Set the 'SortOrderCode' attribute value. Specifies the order in which the response information should be sorted. Refer to OpenTravel Code List Sort Order (SOC).

Parameters:

sortOrderCode -