RequiredPayments.GuaranteePayment (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 RequiredPayments.GuaranteePayment

java.lang.Object
  org.ota.hotel.RequiredPayments.GuaranteePayment

Enclosing class:: RequiredPayments

public static class RequiredPayments.GuaranteePayment
extends java.lang.Object
extends java.lang.Object

Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. 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="GuaranteePayment" maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:AcceptedPaymentsType" name="AcceptedPayments" minOccurs="0"/>
       <xs:element type="ns:AmountPercentType" name="AmountPercent" minOccurs="0"/>
       <xs:element name="Deadline" minOccurs="0" maxOccurs="2">
         <xs:complexType>
           <xs:attributeGroup ref="ns:DeadlineGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:ParagraphType" name="Description" minOccurs="0" maxOccurs="5"/>
       <xs:element name="Address" minOccurs="0" maxOccurs="3">
         <!-- Reference to inner class Address -->
       </xs:element>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute use="optional" name="RetributionType">
       <xs:simpleType>
         <!-- Reference to inner class Retribution -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:string" use="optional" name="PaymentCode"/>
     <xs:attribute use="optional" name="Type">
       <xs:simpleType>
         <!-- Reference to inner class Type -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:string" use="optional" name="GuaranteeCode"/>
     <xs:attribute use="optional" name="GuaranteeType">
       <xs:simpleType>
         <!-- Reference to inner class Guarantee -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:time" use="optional" name="HoldTime"/>
     <xs:attributeGroup ref="ns:DOW_PatternGroup"/>
     <xs:attributeGroup ref="ns:DateTimeSpanGroup"/>
     <xs:attribute type="xs:boolean" use="optional" name="NoCardHolderInfoReqInd"/>
     <xs:attribute type="xs:boolean" use="optional" name="NameInd"/>
     <xs:attribute type="xs:boolean" use="optional" name="AddressInd"/>
     <xs:attribute type="xs:boolean" use="optional" name="PhoneInd"/>
     <xs:attribute type="xs:boolean" use="optional" name="InterbankNbrInd"/>
     <xs:attribute type="xs:string" use="optional" name="RoomTypeCode"/>
     <xs:attribute type="xs:string" use="optional" name="InfoSource"/>
     <xs:attribute type="xs:boolean" use="optional" name="NonRefundableIndicator"/>
     <xs:attribute type="xs:string" use="optional" name="PolicyCode"/>
   </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"/>

Nested Class Summary
`static class`	`RequiredPayments.GuaranteePayment.Address` The address to which a deposit may be sent.
`static class`	`RequiredPayments.GuaranteePayment.Guarantee` Schema fragment(s) for this class:
`static class`	`RequiredPayments.GuaranteePayment.Retribution` Schema fragment(s) for this class:
`static class`	`RequiredPayments.GuaranteePayment.Type` Schema fragment(s) for this class:

Constructor Summary
`RequiredPayments.GuaranteePayment()`

Method Summary
`void`	`addAddress(RequiredPayments.GuaranteePayment.Address item)` Add a 'Address' element item.
`void`	`addDeadline(DeadlineGroup item)` Add a 'Deadline' element item.
`void`	`addDescription(Paragraph item)` Add a 'Description' element item.
`void`	`clearAddresses()` Remove all 'Address' element items.
`void`	`clearDeadlines()` Remove all 'Deadline' element items.
`void`	`clearDescriptions()` Remove all 'Description' element items.
`AcceptedPayments`	`getAcceptedPayments()` Get the 'AcceptedPayments' element value.
`RequiredPayments.GuaranteePayment.Address`	`getAddress(int index)` Get 'Address' element item by position.
`java.util.List<RequiredPayments.GuaranteePayment.Address>`	`getAddresses()` Get the list of 'Address' element items.
`java.lang.Boolean`	`getAddressInd()` Get the 'AddressInd' attribute value.
`AmountPercent`	`getAmountPercent()` Get the 'AmountPercent' element value.
`DateTimeSpanGroup`	`getDateTimeSpanGroup()` Get the 'DateTimeSpanGroup' attributeGroup value.
`DeadlineGroup`	`getDeadline(int index)` Get 'Deadline' element item by position.
`java.util.List<DeadlineGroup>`	`getDeadlines()` Get the list of 'Deadline' element items.
`Paragraph`	`getDescription(int index)` Get 'Description' element item by position.
`java.util.List<Paragraph>`	`getDescriptions()` Get the list of 'Description' element items.
`DOWPatternGroup`	`getDOWPatternGroup()` Get the 'DOW_PatternGroup' attributeGroup value.
`RequiredPayments.GuaranteePayment.Guarantee`	`getGuarantee()` Get the 'GuaranteeType' attribute value.
`java.lang.String`	`getGuaranteeCode()` Get the 'GuaranteeCode' attribute value.
`java.sql.Time`	`getHoldTime()` Get the 'HoldTime' attribute value.
`java.lang.String`	`getInfoSource()` Get the 'InfoSource' attribute value.
`java.lang.Boolean`	`getInterbankNbrInd()` Get the 'InterbankNbrInd' attribute value.
`java.lang.Boolean`	`getNameInd()` Get the 'NameInd' attribute value.
`java.lang.Boolean`	`getNoCardHolderInfoReqInd()` Get the 'NoCardHolderInfoReqInd' attribute value.
`java.lang.Boolean`	`getNonRefundableIndicator()` Get the 'NonRefundableIndicator' attribute value.
`java.lang.String`	`getPaymentCode()` Get the 'PaymentCode' attribute value.
`java.lang.Boolean`	`getPhoneInd()` Get the 'PhoneInd' attribute value.
`java.lang.String`	`getPolicyCode()` Get the 'PolicyCode' attribute value.
`RequiredPayments.GuaranteePayment.Retribution`	`getRetribution()` Get the 'RetributionType' attribute value.
`java.lang.String`	`getRoomTypeCode()` Get the 'RoomTypeCode' attribute value.
`TPAExtensions`	`getTPAExtensions()` Get the 'TPA_Extensions' element value.
`RequiredPayments.GuaranteePayment.Type`	`getType()` Get the 'Type' attribute value.
`void`	`setAcceptedPayments(AcceptedPayments acceptedPayments)` Set the 'AcceptedPayments' element value.
`void`	`setAddresses(java.util.List<RequiredPayments.GuaranteePayment.Address> list)` Set the list of 'Address' element items.
`void`	`setAddressInd(java.lang.Boolean addressInd)` Set the 'AddressInd' attribute value.
`void`	`setAmountPercent(AmountPercent amountPercent)` Set the 'AmountPercent' element value.
`void`	`setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup)` Set the 'DateTimeSpanGroup' attributeGroup value.
`void`	`setDeadlines(java.util.List<DeadlineGroup> list)` Set the list of 'Deadline' element items.
`void`	`setDescriptions(java.util.List<Paragraph> list)` Set the list of 'Description' element items.
`void`	`setDOWPatternGroup(DOWPatternGroup DOWPatternGroup)` Set the 'DOW_PatternGroup' attributeGroup value.
`void`	`setGuarantee(RequiredPayments.GuaranteePayment.Guarantee guarantee)` Set the 'GuaranteeType' attribute value.
`void`	`setGuaranteeCode(java.lang.String guaranteeCode)` Set the 'GuaranteeCode' attribute value.
`void`	`setHoldTime(java.sql.Time holdTime)` Set the 'HoldTime' attribute value.
`void`	`setInfoSource(java.lang.String infoSource)` Set the 'InfoSource' attribute value.
`void`	`setInterbankNbrInd(java.lang.Boolean interbankNbrInd)` Set the 'InterbankNbrInd' attribute value.
`void`	`setNameInd(java.lang.Boolean nameInd)` Set the 'NameInd' attribute value.
`void`	`setNoCardHolderInfoReqInd(java.lang.Boolean noCardHolderInfoReqInd)` Set the 'NoCardHolderInfoReqInd' attribute value.
`void`	`setNonRefundableIndicator(java.lang.Boolean nonRefundableIndicator)` Set the 'NonRefundableIndicator' attribute value.
`void`	`setPaymentCode(java.lang.String paymentCode)` Set the 'PaymentCode' attribute value.
`void`	`setPhoneInd(java.lang.Boolean phoneInd)` Set the 'PhoneInd' attribute value.
`void`	`setPolicyCode(java.lang.String policyCode)` Set the 'PolicyCode' attribute value.
`void`	`setRetribution(RequiredPayments.GuaranteePayment.Retribution retribution)` Set the 'RetributionType' attribute value.
`void`	`setRoomTypeCode(java.lang.String roomTypeCode)` Set the 'RoomTypeCode' attribute value.
`void`	`setTPAExtensions(TPAExtensions TPAExtensions)` Set the 'TPA_Extensions' element value.
`void`	`setType(RequiredPayments.GuaranteePayment.Type type)` Set the 'Type' attribute value.
`int`	`sizeAddresses()` Get the number of 'Address' element items.
`int`	`sizeDeadlines()` Get the number of 'Deadline' element items.
`int`	`sizeDescriptions()` Get the number of 'Description' element items.

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

Constructor Detail

RequiredPayments.GuaranteePayment

public RequiredPayments.GuaranteePayment()

Method Detail

getAcceptedPayments

public AcceptedPayments getAcceptedPayments()

Get the 'AcceptedPayments' element value. Collection of forms of payment accepted for payment.

Returns:: value

setAcceptedPayments

public void setAcceptedPayments(AcceptedPayments acceptedPayments)

Set the 'AcceptedPayments' element value. Collection of forms of payment accepted for payment.

Parameters:: acceptedPayments -

getAmountPercent

public AmountPercent getAmountPercent()

Get the 'AmountPercent' element value. Payment expressed as a fixed amount, or a percentage of/or room nights.

Returns:: value

setAmountPercent

public void setAmountPercent(AmountPercent amountPercent)

Set the 'AmountPercent' element value. Payment expressed as a fixed amount, or a percentage of/or room nights.

Parameters:: amountPercent -

getDeadlines

public java.util.List<DeadlineGroup> getDeadlines()

Get the list of 'Deadline' element items. Payment deadline, absolute or relative

Returns:: list

setDeadlines

public void setDeadlines(java.util.List<DeadlineGroup> list)

Set the list of 'Deadline' element items. Payment deadline, absolute or relative

Parameters:: list -

sizeDeadlines

public int sizeDeadlines()

Get the number of 'Deadline' element items.

Returns:: count

addDeadline

public void addDeadline(DeadlineGroup item)

Add a 'Deadline' element item.

Parameters:: item -

getDeadline

public DeadlineGroup getDeadline(int index)

Get 'Deadline' element item by position.

Parameters:: index -
Returns:: item

clearDeadlines

public void clearDeadlines()

Remove all 'Deadline' element items.

getDescriptions

public java.util.List<Paragraph> getDescriptions()

Get the list of 'Description' element items. Text description of the Payment in a given language.

Returns:: list

setDescriptions

public void setDescriptions(java.util.List<Paragraph> list)

Set the list of 'Description' element items. Text description of the Payment in a given language.

Parameters:: list -

sizeDescriptions

public int sizeDescriptions()

Get the number of 'Description' element items.

Returns:: count

addDescription

public void addDescription(Paragraph item)

Add a 'Description' element item.

Parameters:: item -

getDescription

public Paragraph getDescription(int index)

Get 'Description' element item by position.

Parameters:: index -
Returns:: item

clearDescriptions

public void clearDescriptions()

Remove all 'Description' element items.

getAddresses

public java.util.List<RequiredPayments.GuaranteePayment.Address> getAddresses()

Get the list of 'Address' element items.

Returns:: list

setAddresses

public void setAddresses(java.util.List<RequiredPayments.GuaranteePayment.Address> list)

Set the list of 'Address' element items.

Parameters:: list -

sizeAddresses

public int sizeAddresses()

Get the number of 'Address' element items.

Returns:: count

addAddress

public void addAddress(RequiredPayments.GuaranteePayment.Address item)

Add a 'Address' element item.

Parameters:: item -

getAddress

public RequiredPayments.GuaranteePayment.Address getAddress(int index)

Get 'Address' element item by position.

Parameters:: index -
Returns:: item

clearAddresses

public void clearAddresses()

Remove all 'Address' element items.

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 -

getRetribution

public RequiredPayments.GuaranteePayment.Retribution getRetribution()

Get the 'RetributionType' attribute value. An enumerated type defining the type of action taken when the deadline has been exceeded. Valid values: Res Automatically Cancelled, Res No Longer Guaranteed.

Returns:: value

setRetribution

public void setRetribution(RequiredPayments.GuaranteePayment.Retribution retribution)

Set the 'RetributionType' attribute value. An enumerated type defining the type of action taken when the deadline has been exceeded. Valid values: Res Automatically Cancelled, Res No Longer Guaranteed.

Parameters:: retribution -

getPaymentCode

public java.lang.String getPaymentCode()

Get the 'PaymentCode' attribute value. This defines the form of payment. Recommended usage of this is with the Payment Type in OpenTravel Code List, this datatype will be updated in the future. In order to maintain forward compatability a change is not being made in this publication. This will be corrected in a future version, when a major update is released.

Returns:: value

setPaymentCode

public void setPaymentCode(java.lang.String paymentCode)

Set the 'PaymentCode' attribute value. This defines the form of payment. Recommended usage of this is with the Payment Type in OpenTravel Code List, this datatype will be updated in the future. In order to maintain forward compatability a change is not being made in this publication. This will be corrected in a future version, when a major update is released.

Parameters:: paymentCode -

getType

public RequiredPayments.GuaranteePayment.Type getType()

Get the 'Type' attribute value. Used to specify the type of information being sent (i.e., RequiredPayment, GuaranteePolicy, AcceptedPaymentForms)

Returns:: value

setType

public void setType(RequiredPayments.GuaranteePayment.Type type)

Set the 'Type' attribute value. Used to specify the type of information being sent (i.e., RequiredPayment, GuaranteePolicy, AcceptedPaymentForms)

Parameters:: type -

getGuaranteeCode

public java.lang.String getGuaranteeCode()

Get the 'GuaranteeCode' attribute value. Guarantee Code

Returns:: value

setGuaranteeCode

public void setGuaranteeCode(java.lang.String guaranteeCode)

Set the 'GuaranteeCode' attribute value. Guarantee Code

Parameters:: guaranteeCode -

getGuarantee

public RequiredPayments.GuaranteePayment.Guarantee getGuarantee()

Get the 'GuaranteeType' attribute value. GuaranteeType : GuaranteeType An enumerated type defining the guarantee to be applied to this reservation.

Returns:: value

setGuarantee

public void setGuarantee(RequiredPayments.GuaranteePayment.Guarantee guarantee)

Set the 'GuaranteeType' attribute value. GuaranteeType : GuaranteeType An enumerated type defining the guarantee to be applied to this reservation.

Parameters:: guarantee -

getHoldTime

public java.sql.Time getHoldTime()

Get the 'HoldTime' attribute value. The room will held up until this time without a guarantee.

Returns:: value

setHoldTime

public void setHoldTime(java.sql.Time holdTime)

Set the 'HoldTime' attribute value. The room will held up until this time without a guarantee.

Parameters:: holdTime -

getDOWPatternGroup

public DOWPatternGroup getDOWPatternGroup()

Get the 'DOW_PatternGroup' attributeGroup value.

Returns:: value

setDOWPatternGroup

public void setDOWPatternGroup(DOWPatternGroup DOWPatternGroup)

Set the 'DOW_PatternGroup' attributeGroup value.

Parameters:: DOWPatternGroup -

getDateTimeSpanGroup

public DateTimeSpanGroup getDateTimeSpanGroup()

Get the 'DateTimeSpanGroup' attributeGroup value.

Returns:: value

setDateTimeSpanGroup

public void setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup)

Set the 'DateTimeSpanGroup' attributeGroup value.

Parameters:: dateTimeSpanGroup -

getNoCardHolderInfoReqInd

public java.lang.Boolean getNoCardHolderInfoReqInd()

Get the 'NoCardHolderInfoReqInd' attribute value. If true, no credit cardholder information is required for guarantee/deposit.

Returns:: value

setNoCardHolderInfoReqInd

public void setNoCardHolderInfoReqInd(java.lang.Boolean noCardHolderInfoReqInd)

Set the 'NoCardHolderInfoReqInd' attribute value. If true, no credit cardholder information is required for guarantee/deposit.

Parameters:: noCardHolderInfoReqInd -

getNameInd

public java.lang.Boolean getNameInd()

Get the 'NameInd' attribute value. If true, the credit cardholder name is required for guarantee/deposit.

Returns:: value

setNameInd

public void setNameInd(java.lang.Boolean nameInd)

Set the 'NameInd' attribute value. If true, the credit cardholder name is required for guarantee/deposit.

Parameters:: nameInd -

getAddressInd

public java.lang.Boolean getAddressInd()

Get the 'AddressInd' attribute value. If true, the credit cardholder address is required for guarantee/deposit.

Returns:: value

setAddressInd

public void setAddressInd(java.lang.Boolean addressInd)

Set the 'AddressInd' attribute value. If true, the credit cardholder address is required for guarantee/deposit.

Parameters:: addressInd -

getPhoneInd

public java.lang.Boolean getPhoneInd()

Get the 'PhoneInd' attribute value. If true, the credit cardholder phone number is required for guarantee/deposit.

Returns:: value

setPhoneInd

public void setPhoneInd(java.lang.Boolean phoneInd)

Set the 'PhoneInd' attribute value. If true, the credit cardholder phone number is required for guarantee/deposit.

Parameters:: phoneInd -

getInterbankNbrInd

public java.lang.Boolean getInterbankNbrInd()

Get the 'InterbankNbrInd' attribute value. If true, the Interbank Card Association number is required for guarantee/deposit.

Returns:: value

setInterbankNbrInd

public void setInterbankNbrInd(java.lang.Boolean interbankNbrInd)

Set the 'InterbankNbrInd' attribute value. If true, the Interbank Card Association number is required for guarantee/deposit.

Parameters:: interbankNbrInd -

getRoomTypeCode

public java.lang.String getRoomTypeCode()

Get the 'RoomTypeCode' attribute value. A system specific room type to which this guarantee payment information applies.

Returns:: value

setRoomTypeCode

public void setRoomTypeCode(java.lang.String roomTypeCode)

Set the 'RoomTypeCode' attribute value. A system specific room type to which this guarantee payment information applies.

Parameters:: roomTypeCode -

getInfoSource

public java.lang.String getInfoSource()

Get the 'InfoSource' attribute value. To specify the source of the rate of exchange for a currency code.

Returns:: value

setInfoSource

public void setInfoSource(java.lang.String infoSource)

Set the 'InfoSource' attribute value. To specify the source of the rate of exchange for a currency code.

Parameters:: infoSource -

getNonRefundableIndicator

public java.lang.Boolean getNonRefundableIndicator()

Get the 'NonRefundableIndicator' attribute value. When true, indicates that any prepayment for the reservation is non refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline.

Returns:: value

setNonRefundableIndicator

public void setNonRefundableIndicator(java.lang.Boolean nonRefundableIndicator)

Set the 'NonRefundableIndicator' attribute value. When true, indicates that any prepayment for the reservation is non refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline.

Parameters:: nonRefundableIndicator -

getPolicyCode

public java.lang.String getPolicyCode()

Get the 'PolicyCode' attribute value. Used to specify the type of payment policy.

Returns:: value

setPolicyCode

public void setPolicyCode(java.lang.String policyCode)

Set the 'PolicyCode' attribute value. Used to specify the type of payment policy.

Parameters:: policyCode -