org.ota.shared
Class PaymentCard

java.lang.Object
  org.ota.shared.PaymentCard

Direct Known Subclasses:

DemandTicketRQ.PaymentInfo.CreditCardInfo

public class PaymentCard
extends java.lang.Object

Identification about a specific credit card 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="PaymentCardType">
   <xs:sequence>
     <xs:element type="xs:string" name="CardHolderName" minOccurs="0"/>
     <xs:element name="CardIssuerName" minOccurs="0">
       <!-- Reference to inner class CardIssuerName -->
     </xs:element>
     <xs:element type="ns:AddressType" name="Address" minOccurs="0"/>
     <xs:element name="Telephone" minOccurs="0" maxOccurs="5">
       <xs:complexType>
         <xs:attributeGroup ref="ns:TelephoneInfoGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element type="ns:EmailType" name="Email" minOccurs="0" maxOccurs="3"/>
     <xs:element name="CustLoyalty" minOccurs="0" maxOccurs="5">
       <xs:complexType>
         <xs:attributeGroup ref="ns:CustomerLoyaltyGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="SignatureOnFile" minOccurs="0">
       <!-- Reference to inner class SignatureOnFile -->
     </xs:element>
     <xs:element name="MagneticStripe" minOccurs="0">
       <!-- Reference to inner class MagneticStripe -->
     </xs:element>
   </xs:sequence>
   <xs:attributeGroup ref="ns:PrivacyGroup"/>
   <xs:attribute type="xs:string" use="optional" name="CardType"/>
   <xs:attribute type="xs:string" use="optional" name="CardCode"/>
   <xs:attribute type="xs:string" use="optional" name="CardNumber"/>
   <xs:attribute type="xs:string" use="optional" name="SeriesCode"/>
   <xs:attributeGroup ref="ns:PaymentCardDateGroup"/>
   <xs:attribute type="xs:string" use="optional" name="MaskedCardNumber"/>
   <xs:attribute type="xs:string" use="optional" name="CardHolderRPH"/>
   <xs:attribute type="xs:boolean" use="optional" name="ExtendPaymentIndicator"/>
   <xs:attribute type="xs:string" use="optional" name="CountryOfIssue"/>
   <xs:attribute type="xs:int" use="optional" name="ExtendedPaymentQuantity"/>
   <xs:attribute type="xs:boolean" use="optional" name="SignatureOnFileIndicator"/>
   <xs:attribute type="xs:string" use="optional" name="CompanyCardReference"/>
   <xs:attribute type="xs:string" use="optional" name="Remark"/>
   <xs:attribute type="xs:string" use="optional" name="EncryptionKey"/>
 </xs:complexType>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PaymentCardDateGroup">
   <xs:attribute type="xs:string" use="optional" name="EffectiveDate"/>
   <xs:attribute type="xs:string" use="optional" name="ExpireDate"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class	PaymentCard.CardIssuerName Issuer of the card.
static class	PaymentCard.MagneticStripe Card Magnetic Stripe Data as defined by ISO 7813 for banking cards.
static class	PaymentCard.SignatureOnFile Indicates if the signature is authorized as a form of guarantee.

Constructor Summary

PaymentCard()

Method Summary

void	addCustLoyalty(CustomerLoyaltyGroup item) Add a 'CustLoyalty' element item.
void	addEmail(Email item) Add a 'Email' element item.
void	addTelephone(TelephoneInfoGroup item) Add a 'Telephone' element item.
void	clearCustLoyalties() Remove all 'CustLoyalty' element items.
void	clearEmails() Remove all 'Email' element items.
void	clearTelephones() Remove all 'Telephone' element items.
Address	getAddress() Get the 'Address' element value.
java.lang.String	getCard() Get the 'CardType' attribute value.
java.lang.String	getCardCode() Get the 'CardCode' attribute value.
java.lang.String	getCardHolderName() Get the 'CardHolderName' element value.
java.lang.String	getCardHolderRPH() Get the 'CardHolderRPH' attribute value.
PaymentCard.CardIssuerName	getCardIssuerName() Get the 'CardIssuerName' element value.
java.lang.String	getCardNumber() Get the 'CardNumber' attribute value.
java.lang.String	getCompanyCardReference() Get the 'CompanyCardReference' attribute value.
java.lang.String	getCountryOfIssue() Get the 'CountryOfIssue' attribute value.
java.util.List<CustomerLoyaltyGroup>	getCustLoyalties() Get the list of 'CustLoyalty' element items.
CustomerLoyaltyGroup	getCustLoyalty(int index) Get 'CustLoyalty' element item by position.
java.lang.String	getEffectiveDate() Get the 'EffectiveDate' attribute value.
Email	getEmail(int index) Get 'Email' element item by position.
java.util.List<Email>	getEmails() Get the list of 'Email' element items.
java.lang.String	getEncryptionKey() Get the 'EncryptionKey' attribute value.
java.lang.String	getExpireDate() Get the 'ExpireDate' attribute value.
java.lang.Integer	getExtendedPaymentQuantity() Get the 'ExtendedPaymentQuantity' attribute value.
java.lang.Boolean	getExtendPaymentIndicator() Get the 'ExtendPaymentIndicator' attribute value.
PaymentCard.MagneticStripe	getMagneticStripe() Get the 'MagneticStripe' element value.
java.lang.String	getMaskedCardNumber() Get the 'MaskedCardNumber' attribute value.
PrivacyGroup	getPrivacyGroup() Get the 'PrivacyGroup' attributeGroup value.
java.lang.String	getRemark() Get the 'Remark' attribute value.
java.lang.String	getSeriesCode() Get the 'SeriesCode' attribute value.
PaymentCard.SignatureOnFile	getSignatureOnFile() Get the 'SignatureOnFile' element value.
java.lang.Boolean	getSignatureOnFileIndicator() Get the 'SignatureOnFileIndicator' attribute value.
TelephoneInfoGroup	getTelephone(int index) Get 'Telephone' element item by position.
java.util.List<TelephoneInfoGroup>	getTelephones() Get the list of 'Telephone' element items.
void	setAddress(Address address) Set the 'Address' element value.
void	setCard(java.lang.String card) Set the 'CardType' attribute value.
void	setCardCode(java.lang.String cardCode) Set the 'CardCode' attribute value.
void	setCardHolderName(java.lang.String cardHolderName) Set the 'CardHolderName' element value.
void	setCardHolderRPH(java.lang.String cardHolderRPH) Set the 'CardHolderRPH' attribute value.
void	setCardIssuerName(PaymentCard.CardIssuerName cardIssuerName) Set the 'CardIssuerName' element value.
void	setCardNumber(java.lang.String cardNumber) Set the 'CardNumber' attribute value.
void	setCompanyCardReference(java.lang.String companyCardReference) Set the 'CompanyCardReference' attribute value.
void	setCountryOfIssue(java.lang.String countryOfIssue) Set the 'CountryOfIssue' attribute value.
void	setCustLoyalties(java.util.List<CustomerLoyaltyGroup> list) Set the list of 'CustLoyalty' element items.
void	setEffectiveDate(java.lang.String effectiveDate) Set the 'EffectiveDate' attribute value.
void	setEmails(java.util.List<Email> list) Set the list of 'Email' element items.
void	setEncryptionKey(java.lang.String encryptionKey) Set the 'EncryptionKey' attribute value.
void	setExpireDate(java.lang.String expireDate) Set the 'ExpireDate' attribute value.
void	setExtendedPaymentQuantity(java.lang.Integer extendedPaymentQuantity) Set the 'ExtendedPaymentQuantity' attribute value.
void	setExtendPaymentIndicator(java.lang.Boolean extendPaymentIndicator) Set the 'ExtendPaymentIndicator' attribute value.
void	setMagneticStripe(PaymentCard.MagneticStripe magneticStripe) Set the 'MagneticStripe' element value.
void	setMaskedCardNumber(java.lang.String maskedCardNumber) Set the 'MaskedCardNumber' attribute value.
void	setPrivacyGroup(PrivacyGroup privacyGroup) Set the 'PrivacyGroup' attributeGroup value.
void	setRemark(java.lang.String remark) Set the 'Remark' attribute value.
void	setSeriesCode(java.lang.String seriesCode) Set the 'SeriesCode' attribute value.
void	setSignatureOnFile(PaymentCard.SignatureOnFile signatureOnFile) Set the 'SignatureOnFile' element value.
void	setSignatureOnFileIndicator(java.lang.Boolean signatureOnFileIndicator) Set the 'SignatureOnFileIndicator' attribute value.
void	setTelephones(java.util.List<TelephoneInfoGroup> list) Set the list of 'Telephone' element items.
int	sizeCustLoyalties() Get the number of 'CustLoyalty' element items.
int	sizeEmails() Get the number of 'Email' element items.
int	sizeTelephones() Get the number of 'Telephone' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentCard

public PaymentCard()

Method Detail

getCardHolderName

public java.lang.String getCardHolderName()

Get the 'CardHolderName' element value. Name of the card holder.

Returns:

value

setCardHolderName

public void setCardHolderName(java.lang.String cardHolderName)

Set the 'CardHolderName' element value. Name of the card holder.

Parameters:

cardHolderName -

getCardIssuerName

public PaymentCard.CardIssuerName getCardIssuerName()

Get the 'CardIssuerName' element value.

Returns:

value

setCardIssuerName

public void setCardIssuerName(PaymentCard.CardIssuerName cardIssuerName)

Set the 'CardIssuerName' element value.

Parameters:

cardIssuerName -

getAddress

public Address getAddress()

Get the 'Address' element value. Card holder's address used for additional authorization checks.

Returns:

value

setAddress

public void setAddress(Address address)

Set the 'Address' element value. Card holder's address used for additional authorization checks.

Parameters:

address -

getTelephones

public java.util.List<TelephoneInfoGroup> getTelephones()

Get the list of 'Telephone' element items. Card holder's telephone number used for additional authorization checks.

Returns:

list

setTelephones

public void setTelephones(java.util.List<TelephoneInfoGroup> list)

Set the list of 'Telephone' element items. Card holder's telephone number used for additional authorization checks.

Parameters:

list -

sizeTelephones

public int sizeTelephones()

Get the number of 'Telephone' element items.

Returns:

count

addTelephone

public void addTelephone(TelephoneInfoGroup item)

Add a 'Telephone' element item.

Parameters:

item -

getTelephone

public TelephoneInfoGroup getTelephone(int index)

Get 'Telephone' element item by position.

Parameters:

index -

Returns:

item

clearTelephones

public void clearTelephones()

Remove all 'Telephone' element items.

getEmails

public java.util.List<Email> getEmails()

Get the list of 'Email' element items. Card holder's email address(es) used for additional authorization checks.

Returns:

list

setEmails

public void setEmails(java.util.List<Email> list)

Set the list of 'Email' element items. Card holder's email address(es) used for additional authorization checks.

Parameters:

list -

sizeEmails

public int sizeEmails()

Get the number of 'Email' element items.

Returns:

count

addEmail

public void addEmail(Email item)

Add a 'Email' element item.

Parameters:

item -

getEmail

public Email getEmail(int index)

Get 'Email' element item by position.

Parameters:

index -

Returns:

item

clearEmails

public void clearEmails()

Remove all 'Email' element items.

getCustLoyalties

public java.util.List<CustomerLoyaltyGroup> getCustLoyalties()

Get the list of 'CustLoyalty' element items. Customer loyalty information used for additional authorization checks.

Returns:

list

setCustLoyalties

public void setCustLoyalties(java.util.List<CustomerLoyaltyGroup> list)

Set the list of 'CustLoyalty' element items. Customer loyalty information used for additional authorization checks.

Parameters:

list -

sizeCustLoyalties

public int sizeCustLoyalties()

Get the number of 'CustLoyalty' element items.

Returns:

count

addCustLoyalty

public void addCustLoyalty(CustomerLoyaltyGroup item)

Add a 'CustLoyalty' element item.

Parameters:

item -

getCustLoyalty

public CustomerLoyaltyGroup getCustLoyalty(int index)

Get 'CustLoyalty' element item by position.

Parameters:

index -

Returns:

item

clearCustLoyalties

public void clearCustLoyalties()

Remove all 'CustLoyalty' element items.

getSignatureOnFile

public PaymentCard.SignatureOnFile getSignatureOnFile()

Get the 'SignatureOnFile' element value.

Returns:

value

setSignatureOnFile

public void setSignatureOnFile(PaymentCard.SignatureOnFile signatureOnFile)

Set the 'SignatureOnFile' element value.

Parameters:

signatureOnFile -

getMagneticStripe

public PaymentCard.MagneticStripe getMagneticStripe()

Get the 'MagneticStripe' element value.

Returns:

value

setMagneticStripe

public void setMagneticStripe(PaymentCard.MagneticStripe magneticStripe)

Set the 'MagneticStripe' element value.

Parameters:

magneticStripe -

getPrivacyGroup

public PrivacyGroup getPrivacyGroup()

Get the 'PrivacyGroup' attributeGroup value. Allows for control of the sharing of payment card data between parties.

Returns:

value

setPrivacyGroup

public void setPrivacyGroup(PrivacyGroup privacyGroup)

Set the 'PrivacyGroup' attributeGroup value. Allows for control of the sharing of payment card data between parties.

Parameters:

privacyGroup -

getCard

public java.lang.String getCard()

Get the 'CardType' attribute value. Indicates the type of magnetic striped card. Refer to OpenTravel Code ListCard Type (CDT).

Returns:

value

setCard

public void setCard(java.lang.String card)

Set the 'CardType' attribute value. Indicates the type of magnetic striped card. Refer to OpenTravel Code ListCard Type (CDT).

Parameters:

card -

getCardCode

public java.lang.String getCardCode()

Get the 'CardCode' attribute value. The 2 character code of the credit card issuer.

Returns:

value

setCardCode

public void setCardCode(java.lang.String cardCode)

Set the 'CardCode' attribute value. The 2 character code of the credit card issuer.

Parameters:

cardCode -

getCardNumber

public java.lang.String getCardNumber()

Get the 'CardNumber' attribute value. Credit card number embossed on the card.

Returns:

value

setCardNumber

public void setCardNumber(java.lang.String cardNumber)

Set the 'CardNumber' attribute value. Credit card number embossed on the card.

Parameters:

cardNumber -

getSeriesCode

public java.lang.String getSeriesCode()

Get the 'SeriesCode' attribute value. Verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2 ), card validation code number (CVC2) on credit card.

Returns:

value

setSeriesCode

public void setSeriesCode(java.lang.String seriesCode)

Set the 'SeriesCode' attribute value. Verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2 ), card validation code number (CVC2) on credit card.

Parameters:

seriesCode -

getEffectiveDate

public java.lang.String getEffectiveDate()

Get the 'EffectiveDate' attribute value. Indicates the starting date.

Returns:

value

setEffectiveDate

public void setEffectiveDate(java.lang.String effectiveDate)

Set the 'EffectiveDate' attribute value. Indicates the starting date.

Parameters:

effectiveDate -

getExpireDate

public java.lang.String getExpireDate()

Get the 'ExpireDate' attribute value. Indicates the ending date.

Returns:

value

setExpireDate

public void setExpireDate(java.lang.String expireDate)

Set the 'ExpireDate' attribute value. Indicates the ending date.

Parameters:

expireDate -

getMaskedCardNumber

public java.lang.String getMaskedCardNumber()

Get the 'MaskedCardNumber' attribute value. May be used to send a concealed credit card number (e.g., xxxxxxxxxxxx9922).

Returns:

value

setMaskedCardNumber

public void setMaskedCardNumber(java.lang.String maskedCardNumber)

Set the 'MaskedCardNumber' attribute value. May be used to send a concealed credit card number (e.g., xxxxxxxxxxxx9922).

Parameters:

maskedCardNumber -

getCardHolderRPH

public java.lang.String getCardHolderRPH()

Get the 'CardHolderRPH' attribute value. Provides a reference pointer that links the payment card to the payment card holder.

Returns:

value

setCardHolderRPH

public void setCardHolderRPH(java.lang.String cardHolderRPH)

Set the 'CardHolderRPH' attribute value. Provides a reference pointer that links the payment card to the payment card holder.

Parameters:

cardHolderRPH -

getExtendPaymentIndicator

public java.lang.Boolean getExtendPaymentIndicator()

Get the 'ExtendPaymentIndicator' attribute value. When true, the credit card company is requested to delay the date on which the amount of this transaction is applied to the customer's account.

Returns:

value

setExtendPaymentIndicator

public void setExtendPaymentIndicator(java.lang.Boolean extendPaymentIndicator)

Set the 'ExtendPaymentIndicator' attribute value. When true, the credit card company is requested to delay the date on which the amount of this transaction is applied to the customer's account.

Parameters:

extendPaymentIndicator -

getCountryOfIssue

public java.lang.String getCountryOfIssue()

Get the 'CountryOfIssue' attribute value. Code for the country where the credit card was issued.

Returns:

value

setCountryOfIssue

public void setCountryOfIssue(java.lang.String countryOfIssue)

Set the 'CountryOfIssue' attribute value. Code for the country where the credit card was issued.

Parameters:

countryOfIssue -

getExtendedPaymentQuantity

public java.lang.Integer getExtendedPaymentQuantity()

Get the 'ExtendedPaymentQuantity' attribute value. A code used to specifiy the installment payment plan or number of payment installments.

Returns:

value

setExtendedPaymentQuantity

public void setExtendedPaymentQuantity(java.lang.Integer extendedPaymentQuantity)

Set the 'ExtendedPaymentQuantity' attribute value. A code used to specifiy the installment payment plan or number of payment installments.

Parameters:

extendedPaymentQuantity -

getSignatureOnFileIndicator

public java.lang.Boolean getSignatureOnFileIndicator()

Get the 'SignatureOnFileIndicator' attribute value. When true, the cardholder signature is on file.

Returns:

value

setSignatureOnFileIndicator

public void setSignatureOnFileIndicator(java.lang.Boolean signatureOnFileIndicator)

Set the 'SignatureOnFileIndicator' attribute value. When true, the cardholder signature is on file.

Parameters:

signatureOnFileIndicator -

getCompanyCardReference

public java.lang.String getCompanyCardReference()

Get the 'CompanyCardReference' attribute value. Reference to the company sponsor for this particular card (e.g. a Universal Airline Travel Plan (UATP) card or any loyalty scheme sponsored card).

Returns:

value

setCompanyCardReference

public void setCompanyCardReference(java.lang.String companyCardReference)

Set the 'CompanyCardReference' attribute value. Reference to the company sponsor for this particular card (e.g. a Universal Airline Travel Plan (UATP) card or any loyalty scheme sponsored card).

Parameters:

companyCardReference -

getRemark

public java.lang.String getRemark()

Get the 'Remark' attribute value. A remark associated with this payment card.

Returns:

value

setRemark

public void setRemark(java.lang.String remark)

Set the 'Remark' attribute value. A remark associated with this payment card.

Parameters:

remark -

getEncryptionKey

public java.lang.String getEncryptionKey()

Get the 'EncryptionKey' attribute value. 'Database key necessary to retrieve the full credit card (compliant with PCI DSS standards).

Returns:

value

setEncryptionKey

public void setEncryptionKey(java.lang.String encryptionKey)

Set the 'EncryptionKey' attribute value. 'Database key necessary to retrieve the full credit card (compliant with PCI DSS standards).

Parameters:

encryptionKey -