org.ota.destination
Class Item

java.lang.Object
  extended by org.ota.destination.Item

public class Item
extends java.lang.Object

The details of a destination activity item. 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="ItemType">
   <xs:sequence>
     <xs:element type="ns:TotalType" name="NegotiatedPrice"/>
     <xs:element type="ns:TotalType" name="SellingPrice" minOccurs="0"/>
     <xs:element name="SubAllocation" minOccurs="0">
       <!-- Reference to inner class SubAllocation -->
     </xs:element>
     <xs:element type="ns:SpecialRequestType" name="SpecialRequest" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element name="HotelStay" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:HotelReferenceGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="ItemReferences">
       <xs:complexType>
         <xs:sequence>
           <xs:element type="ns:UniqueID_Type" name="ItemReference" maxOccurs="unbounded"/>
         </xs:sequence>
       </xs:complexType>
     </xs:element>
   </xs:sequence>
   <xs:attribute type="xs:string" use="required" name="ItemCode"/>
   <xs:attribute type="xs:string" use="optional" name="OptionCode"/>
   <xs:attribute type="xs:date" use="required" name="SelectedDate"/>
   <xs:attribute type="xs:int" use="optional" name="Quantity"/>
   <xs:attribute type="xs:time" use="optional" name="SelectedTime"/>
 </xs:complexType>
 


Nested Class Summary
static class Item.SubAllocation
          If traveler suballocation is allowed (see Capabilities), the set of travelers booking this item.
 
Constructor Summary
Item()
           
 
Method Summary
 void addItemReference(UniqueID item)
          Add a 'ItemReference' element item.
 void addSpecialRequest(SpecialRequest item)
          Add a 'SpecialRequest' element item.
 void clearItemReferences()
          Remove all 'ItemReference' element items.
 void clearSpecialRequests()
          Remove all 'SpecialRequest' element items.
 HotelReferenceGroup getHotelStay()
          Get the 'HotelReferenceGroup' attributeGroup value.
 java.lang.String getItemCode()
          Get the 'ItemCode' attribute value.
 UniqueID getItemReference(int index)
          Get 'ItemReference' element item by position.
 java.util.List<UniqueID> getItemReferences()
          Get the list of 'ItemReference' element items.
 Total getNegotiatedPrice()
          Get the 'NegotiatedPrice' element value.
 java.lang.String getOptionCode()
          Get the 'OptionCode' attribute value.
 java.lang.Integer getQuantity()
          Get the 'Quantity' attribute value.
 java.sql.Date getSelectedDate()
          Get the 'SelectedDate' attribute value.
 java.sql.Time getSelectedTime()
          Get the 'SelectedTime' attribute value.
 Total getSellingPrice()
          Get the 'SellingPrice' element value.
 SpecialRequest getSpecialRequest(int index)
          Get 'SpecialRequest' element item by position.
 java.util.List<SpecialRequest> getSpecialRequests()
          Get the list of 'SpecialRequest' element items.
 Item.SubAllocation getSubAllocation()
          Get the 'SubAllocation' element value.
 void setHotelStay(HotelReferenceGroup hotelStay)
          Set the 'HotelReferenceGroup' attributeGroup value.
 void setItemCode(java.lang.String itemCode)
          Set the 'ItemCode' attribute value.
 void setItemReferences(java.util.List<UniqueID> list)
          Set the list of 'ItemReference' element items.
 void setNegotiatedPrice(Total negotiatedPrice)
          Set the 'NegotiatedPrice' element value.
 void setOptionCode(java.lang.String optionCode)
          Set the 'OptionCode' attribute value.
 void setQuantity(java.lang.Integer quantity)
          Set the 'Quantity' attribute value.
 void setSelectedDate(java.sql.Date selectedDate)
          Set the 'SelectedDate' attribute value.
 void setSelectedTime(java.sql.Time selectedTime)
          Set the 'SelectedTime' attribute value.
 void setSellingPrice(Total sellingPrice)
          Set the 'SellingPrice' element value.
 void setSpecialRequests(java.util.List<SpecialRequest> list)
          Set the list of 'SpecialRequest' element items.
 void setSubAllocation(Item.SubAllocation subAllocation)
          Set the 'SubAllocation' element value.
 int sizeItemReferences()
          Get the number of 'ItemReference' element items.
 int sizeSpecialRequests()
          Get the number of 'SpecialRequest' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Item

public Item()
Method Detail

getNegotiatedPrice

public Total getNegotiatedPrice()
Get the 'NegotiatedPrice' element value. The price agreed between the two parties.

Returns:
value

setNegotiatedPrice

public void setNegotiatedPrice(Total negotiatedPrice)
Set the 'NegotiatedPrice' element value. The price agreed between the two parties.

Parameters:
negotiatedPrice -

getSellingPrice

public Total getSellingPrice()
Get the 'SellingPrice' element value. The price sold to the end consumer, in case the end supplier must communicate with the customer.

Returns:
value

setSellingPrice

public void setSellingPrice(Total sellingPrice)
Set the 'SellingPrice' element value. The price sold to the end consumer, in case the end supplier must communicate with the customer.

Parameters:
sellingPrice -

getSubAllocation

public Item.SubAllocation getSubAllocation()
Get the 'SubAllocation' element value.

Returns:
value

setSubAllocation

public void setSubAllocation(Item.SubAllocation subAllocation)
Set the 'SubAllocation' element value.

Parameters:
subAllocation -

getSpecialRequests

public java.util.List<SpecialRequest> getSpecialRequests()
Get the list of 'SpecialRequest' element items. Any special requests against this particular item

Returns:
list

setSpecialRequests

public void setSpecialRequests(java.util.List<SpecialRequest> list)
Set the list of 'SpecialRequest' element items. Any special requests against this particular item

Parameters:
list -

sizeSpecialRequests

public int sizeSpecialRequests()
Get the number of 'SpecialRequest' element items.

Returns:
count

addSpecialRequest

public void addSpecialRequest(SpecialRequest item)
Add a 'SpecialRequest' element item.

Parameters:
item -

getSpecialRequest

public SpecialRequest getSpecialRequest(int index)
Get 'SpecialRequest' element item by position.

Parameters:
index -
Returns:
item

clearSpecialRequests

public void clearSpecialRequests()
Remove all 'SpecialRequest' element items.


getHotelStay

public HotelReferenceGroup getHotelStay()
Get the 'HotelReferenceGroup' attributeGroup value. Where the guests are staying, allowing the vendor to decide the appropriate pickup point

Returns:
value

setHotelStay

public void setHotelStay(HotelReferenceGroup hotelStay)
Set the 'HotelReferenceGroup' attributeGroup value. Where the guests are staying, allowing the vendor to decide the appropriate pickup point

Parameters:
hotelStay -

getItemReferences

public java.util.List<UniqueID> getItemReferences()
Get the list of 'ItemReference' element items. A collection of trading partners' references to identifiy the activities.

Returns:
list

setItemReferences

public void setItemReferences(java.util.List<UniqueID> list)
Set the list of 'ItemReference' element items. A collection of trading partners' references to identifiy the activities.

Parameters:
list -

sizeItemReferences

public int sizeItemReferences()
Get the number of 'ItemReference' element items.

Returns:
count

addItemReference

public void addItemReference(UniqueID item)
Add a 'ItemReference' element item.

Parameters:
item -

getItemReference

public UniqueID getItemReference(int index)
Get 'ItemReference' element item by position.

Parameters:
index -
Returns:
item

clearItemReferences

public void clearItemReferences()
Remove all 'ItemReference' element items.


getItemCode

public java.lang.String getItemCode()
Get the 'ItemCode' attribute value. The supplier's code identifying this item.

Returns:
value

setItemCode

public void setItemCode(java.lang.String itemCode)
Set the 'ItemCode' attribute value. The supplier's code identifying this item.

Parameters:
itemCode -

getOptionCode

public java.lang.String getOptionCode()
Get the 'OptionCode' attribute value. A code to identify an option within an item.

Returns:
value

setOptionCode

public void setOptionCode(java.lang.String optionCode)
Set the 'OptionCode' attribute value. A code to identify an option within an item.

Parameters:
optionCode -

getSelectedDate

public java.sql.Date getSelectedDate()
Get the 'SelectedDate' attribute value. The selected date of the item.

Returns:
value

setSelectedDate

public void setSelectedDate(java.sql.Date selectedDate)
Set the 'SelectedDate' attribute value. The selected date of the item.

Parameters:
selectedDate -

getQuantity

public java.lang.Integer getQuantity()
Get the 'Quantity' attribute value. The number of items to purchase of this type 1

Returns:
value

setQuantity

public void setQuantity(java.lang.Integer quantity)
Set the 'Quantity' attribute value. The number of items to purchase of this type 1

Parameters:
quantity -

getSelectedTime

public java.sql.Time getSelectedTime()
Get the 'SelectedTime' attribute value. If the item has various times (such as departures) for sale during the day, indicates which time is required.

Returns:
value

setSelectedTime

public void setSelectedTime(java.sql.Time selectedTime)
Set the 'SelectedTime' attribute value. If the item has various times (such as departures) for sale during the day, indicates which time is required.

Parameters:
selectedTime -