Services.Service (JiBX/OTA Full Model)

Overview

Package

Class

Tree

Deprecated

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.ota.hotel
Class Services.Service

java.lang.Object
  org.ota.hotel.Services.Service

Enclosing class:: Services

public static class Services.Service
extends java.lang.Object
extends java.lang.Object

A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. 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="Service" maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:AmountType" name="Price" minOccurs="0" maxOccurs="99"/>
       <xs:element type="ns:ResCommonDetailType" name="ServiceDetails" minOccurs="0"/>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute type="ns:PricingType" use="optional" name="ServicePricingType"/>
     <xs:attribute type="ns:PMS_ResStatusType" use="optional" name="ReservationStatusType"/>
     <xs:attribute type="xs:string" use="optional" name="ServiceRPH"/>
     <xs:attribute type="xs:string" use="optional" name="ServiceInventoryCode"/>
     <xs:attribute type="xs:string" use="optional" name="RatePlanCode"/>
     <xs:attribute type="xs:string" use="optional" name="InventoryBlockCode"/>
     <xs:attribute type="xs:boolean" use="optional" name="PriceGuaranteed"/>
     <xs:attribute type="xs:boolean" use="optional" name="Inclusive"/>
     <xs:attribute type="xs:int" use="optional" name="Quantity"/>
     <xs:attribute type="xs:boolean" use="optional" name="RequestedIndicator"/>
   </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:simpleType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PMS_ResStatusType">
   <!-- Reference to inner class PMSResStatus -->
 </xs:simpleType>

Nested Class Summary
`static class`	`Services.Service.PMSResStatus` Statuses that exist in a property management system (PMS).

Constructor Summary
`Services.Service()`

Method Summary
`void`	`addPrice(Amount item)` Add a 'Price' element item.
`void`	`clearPrices()` Remove all 'Price' element items.
`java.lang.Boolean`	`getInclusive()` Get the 'Inclusive' attribute value.
`java.lang.String`	`getInventoryBlockCode()` Get the 'InventoryBlockCode' attribute value.
`Amount`	`getPrice(int index)` Get 'Price' element item by position.
`java.lang.Boolean`	`getPriceGuaranteed()` Get the 'PriceGuaranteed' attribute value.
`java.util.List<Amount>`	`getPrices()` Get the list of 'Price' element items.
`java.lang.Integer`	`getQuantity()` Get the 'Quantity' attribute value.
`java.lang.String`	`getRatePlanCode()` Get the 'RatePlanCode' attribute value.
`java.lang.Boolean`	`getRequestedIndicator()` Get the 'RequestedIndicator' attribute value.
`Services.Service.PMSResStatus`	`getReservationStatus()` Get the 'ReservationStatusType' attribute value.
`ResCommonDetail`	`getServiceDetails()` Get the 'ServiceDetails' element value.
`java.lang.String`	`getServiceInventoryCode()` Get the 'ServiceInventoryCode' attribute value.
`Pricing`	`getServicePricing()` Get the 'ServicePricingType' attribute value.
`java.lang.String`	`getServiceRPH()` Get the 'ServiceRPH' attribute value.
`TPAExtensions`	`getTPAExtensions()` Get the 'TPA_Extensions' element value.
`void`	`setInclusive(java.lang.Boolean inclusive)` Set the 'Inclusive' attribute value.
`void`	`setInventoryBlockCode(java.lang.String inventoryBlockCode)` Set the 'InventoryBlockCode' attribute value.
`void`	`setPriceGuaranteed(java.lang.Boolean priceGuaranteed)` Set the 'PriceGuaranteed' attribute value.
`void`	`setPrices(java.util.List<Amount> list)` Set the list of 'Price' element items.
`void`	`setQuantity(java.lang.Integer quantity)` Set the 'Quantity' attribute value.
`void`	`setRatePlanCode(java.lang.String ratePlanCode)` Set the 'RatePlanCode' attribute value.
`void`	`setRequestedIndicator(java.lang.Boolean requestedIndicator)` Set the 'RequestedIndicator' attribute value.
`void`	`setReservationStatus(Services.Service.PMSResStatus reservationStatus)` Set the 'ReservationStatusType' attribute value.
`void`	`setServiceDetails(ResCommonDetail serviceDetails)` Set the 'ServiceDetails' element value.
`void`	`setServiceInventoryCode(java.lang.String serviceInventoryCode)` Set the 'ServiceInventoryCode' attribute value.
`void`	`setServicePricing(Pricing servicePricing)` Set the 'ServicePricingType' attribute value.
`void`	`setServiceRPH(java.lang.String serviceRPH)` Set the 'ServiceRPH' attribute value.
`void`	`setTPAExtensions(TPAExtensions TPAExtensions)` Set the 'TPA_Extensions' element value.
`int`	`sizePrices()` Get the number of 'Price' element items.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Services.Service

public Services.Service()

Method Detail

getPrices

public java.util.List<Amount> getPrices()

Get the list of 'Price' element items. The selling price of this Service.

Returns:: list

setPrices

public void setPrices(java.util.List<Amount> list)

Set the list of 'Price' element items. The selling price of this Service.

Parameters:: list -

sizePrices

public int sizePrices()

Get the number of 'Price' element items.

Returns:: count

addPrice

public void addPrice(Amount item)

Add a 'Price' element item.

Parameters:: item -

getPrice

public Amount getPrice(int index)

Get 'Price' element item by position.

Parameters:: index -
Returns:: item

clearPrices

public void clearPrices()

Remove all 'Price' element items.

getServiceDetails

public ResCommonDetail getServiceDetails()

Get the 'ServiceDetails' element value. Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Service and finally financial information related to the Service, including Guarantee, Deposit and Payment and Cancellation Penalties.

Returns:: value

setServiceDetails

public void setServiceDetails(ResCommonDetail serviceDetails)

Set the 'ServiceDetails' element value. Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Service and finally financial information related to the Service, including Guarantee, Deposit and Payment and Cancellation Penalties.

Parameters:: serviceDetails -

getTPAExtensions

public TPAExtensions getTPAExtensions()

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

setTPAExtensions

public void setTPAExtensions(TPAExtensions TPAExtensions)

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:: TPAExtensions -

getServicePricing

public Pricing getServicePricing()

Get the 'ServicePricingType' attribute value. An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use.

Returns:: value

setServicePricing

public void setServicePricing(Pricing servicePricing)

Set the 'ServicePricingType' attribute value. An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use.

Parameters:: servicePricing -

getReservationStatus

public Services.Service.PMSResStatus getReservationStatus()

Get the 'ReservationStatusType' attribute value. An enumerated type that defines the status of the reservation for this service.

Returns:: value

setReservationStatus

public void setReservationStatus(Services.Service.PMSResStatus reservationStatus)

Set the 'ReservationStatusType' attribute value. An enumerated type that defines the status of the reservation for this service.

Parameters:: reservationStatus -

getServiceRPH

public java.lang.String getServiceRPH()

Get the 'ServiceRPH' attribute value.

Returns:: value

setServiceRPH

public void setServiceRPH(java.lang.String serviceRPH)

Set the 'ServiceRPH' attribute value.

Parameters:: serviceRPH -

getServiceInventoryCode

public java.lang.String getServiceInventoryCode()

Get the 'ServiceInventoryCode' attribute value. The representation of the specific service being reserved.

Returns:: value

setServiceInventoryCode

public void setServiceInventoryCode(java.lang.String serviceInventoryCode)

Set the 'ServiceInventoryCode' attribute value. The representation of the specific service being reserved.

Parameters:: serviceInventoryCode -

getRatePlanCode

public java.lang.String getRatePlanCode()

Get the 'RatePlanCode' attribute value. The representation of the rate plan under which this service was booked.

Returns:: value

setRatePlanCode

public void setRatePlanCode(java.lang.String ratePlanCode)

Set the 'RatePlanCode' attribute value. The representation of the rate plan under which this service was booked.

Parameters:: ratePlanCode -

getInventoryBlockCode

public java.lang.String getInventoryBlockCode()

Get the 'InventoryBlockCode' attribute value. The representation of the block code under which the inventory for this service is categorized.

Returns:: value

setInventoryBlockCode

public void setInventoryBlockCode(java.lang.String inventoryBlockCode)

Set the 'InventoryBlockCode' attribute value. The representation of the block code under which the inventory for this service is categorized.

Parameters:: inventoryBlockCode -

getPriceGuaranteed

public java.lang.Boolean getPriceGuaranteed()

Get the 'PriceGuaranteed' attribute value. Whether the price for this service is guaranteed or quoted and subject to change. Values: False (Price NOT guaranteed) and True (Price is guaranteed).

Returns:: value

setPriceGuaranteed

public void setPriceGuaranteed(java.lang.Boolean priceGuaranteed)

Set the 'PriceGuaranteed' attribute value. Whether the price for this service is guaranteed or quoted and subject to change. Values: False (Price NOT guaranteed) and True (Price is guaranteed).

Parameters:: priceGuaranteed -

getInclusive

public java.lang.Boolean getInclusive()

Get the 'Inclusive' attribute value. Whether the price for this service is included in the room rate. Values: False (or No), and True (or Yes).

Returns:: value

setInclusive

public void setInclusive(java.lang.Boolean inclusive)

Set the 'Inclusive' attribute value. Whether the price for this service is included in the room rate. Values: False (or No), and True (or Yes).

Parameters:: inclusive -

getQuantity

public java.lang.Integer getQuantity()

Get the 'Quantity' attribute value. The number of tickets, rounds of golf, etc. Also serves as the number of persons when pricing class is per person or per person per night.

Returns:: value

setQuantity

public void setQuantity(java.lang.Integer quantity)

Set the 'Quantity' attribute value. The number of tickets, rounds of golf, etc. Also serves as the number of persons when pricing class is per person or per person per night.

Parameters:: quantity -

getRequestedIndicator

public java.lang.Boolean getRequestedIndicator()

Get the 'RequestedIndicator' attribute value. When true, the service has been requested by the guest.

Returns:: value

setRequestedIndicator

public void setRequestedIndicator(java.lang.Boolean requestedIndicator)

Set the 'RequestedIndicator' attribute value. When true, the service has been requested by the guest.

Parameters:: requestedIndicator -