org.ota.misc
Class CancelRQ

java.lang.Object
  org.ota.misc.CancelRQ

public class CancelRQ
extends java.lang.Object

A generic message, available as an action on several OpenTravel services which requests a server to cancel the booking identified by the UniqueID element. 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="OTA_CancelRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" minOccurs="0"/>
       <xs:element name="UniqueID" maxOccurs="5">
         <!-- Reference to inner class UniqueID -->
       </xs:element>
       <xs:element type="ns:VerificationType" name="Verification" minOccurs="0" maxOccurs="5"/>
       <xs:element name="Segment" minOccurs="0" maxOccurs="99">
         <!-- Reference to inner class Segment -->
       </xs:element>
       <xs:element name="CancellationOverrides" minOccurs="0">
         <xs:complexType>
           <xs:sequence>
             <xs:element type="ns:CancelRuleType" name="CancellationOverride" minOccurs="0"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="Reasons" minOccurs="0">
         <!-- Reference to inner class Reasons -->
       </xs:element>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:ReqRespVersion"/>
     <xs:attribute type="ns:TransactionActionType" use="required" name="CancelType"/>
     <xs:attribute type="xs:string" use="optional" name="TravelSector"/>
   </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:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ReqRespVersion">
   <xs:attribute type="xs:string" use="optional" name="ReqRespVersion"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class	CancelRQ.Reasons A collection of reasons for this cancellation.
static class	CancelRQ.Segment Used to specify segments to be cancelled.
static class	CancelRQ.UniqueID This allows a user to send more than one UniqueID where there is more than one UniqueID associated to a single reservation (e.g.

Constructor Summary

CancelRQ()

Method Summary

void	addSegment(CancelRQ.Segment item) Add a 'Segment' element item.
void	addUniqueID(CancelRQ.UniqueID item) Add a 'UniqueID' element item.
void	addVerification(Verification item) Add a 'Verification' element item.
void	clearSegments() Remove all 'Segment' element items.
void	clearUniqueIDs() Remove all 'UniqueID' element items.
void	clearVerifications() Remove all 'Verification' element items.
TransactionAction	getCancel() Get the 'CancelType' attribute value.
CancelRule	getCancellationOverride() Get the 'CancellationOverride' element value.
OTAPayloadStdAttributes	getPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
CancelRQ.Reasons	getReasons() Get the 'Reasons' element value.
java.lang.String	getReqRespVersion() Get the 'ReqRespVersion' attribute value.
CancelRQ.Segment	getSegment(int index) Get 'Segment' element item by position.
java.util.List<CancelRQ.Segment>	getSegments() Get the list of 'Segment' element items.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
java.lang.String	getTravelSector() Get the 'TravelSector' attribute value.
CancelRQ.UniqueID	getUniqueID(int index) Get 'UniqueID' element item by position.
java.util.List<CancelRQ.UniqueID>	getUniqueIDs() Get the list of 'UniqueID' element items.
Verification	getVerification(int index) Get 'Verification' element item by position.
java.util.List<Verification>	getVerifications() Get the list of 'Verification' element items.
void	setCancel(TransactionAction cancel) Set the 'CancelType' attribute value.
void	setCancellationOverride(CancelRule cancellationOverride) Set the 'CancellationOverride' element value.
void	setPayloadStdAttributes(OTAPayloadStdAttributes payloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setReasons(CancelRQ.Reasons reasons) Set the 'Reasons' element value.
void	setReqRespVersion(java.lang.String reqRespVersion) Set the 'ReqRespVersion' attribute value.
void	setSegments(java.util.List<CancelRQ.Segment> list) Set the list of 'Segment' element items.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setTravelSector(java.lang.String travelSector) Set the 'TravelSector' attribute value.
void	setUniqueIDs(java.util.List<CancelRQ.UniqueID> list) Set the list of 'UniqueID' element items.
void	setVerifications(java.util.List<Verification> list) Set the list of 'Verification' element items.
int	sizeSegments() Get the number of 'Segment' element items.
int	sizeUniqueIDs() Get the number of 'UniqueID' element items.
int	sizeVerifications() Get the number of 'Verification' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelRQ

public CancelRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value.

Returns:

value

setPOS

public void setPOS(POS POS)

Set the 'POS' element value.

Parameters:

POS -

getUniqueIDs

public java.util.List<CancelRQ.UniqueID> getUniqueIDs()

Get the list of 'UniqueID' element items.

Returns:

list

setUniqueIDs

public void setUniqueIDs(java.util.List<CancelRQ.UniqueID> list)

Set the list of 'UniqueID' element items.

Parameters:

list -

sizeUniqueIDs

public int sizeUniqueIDs()

Get the number of 'UniqueID' element items.

Returns:

count

addUniqueID

public void addUniqueID(CancelRQ.UniqueID item)

Add a 'UniqueID' element item.

Parameters:

item -

getUniqueID

public CancelRQ.UniqueID getUniqueID(int index)

Get 'UniqueID' element item by position.

Parameters:

index -

Returns:

item

clearUniqueIDs

public void clearUniqueIDs()

Remove all 'UniqueID' element items.

getVerifications

public java.util.List<Verification> getVerifications()

Get the list of 'Verification' element items. This is to be used for verification that the record being canceled is the specific record requested. This is optional and is intended to provide a more secure mechanism to ensure the correct record is being canceled.

Returns:

list

setVerifications

public void setVerifications(java.util.List<Verification> list)

Set the list of 'Verification' element items. This is to be used for verification that the record being canceled is the specific record requested. This is optional and is intended to provide a more secure mechanism to ensure the correct record is being canceled.

Parameters:

list -

sizeVerifications

public int sizeVerifications()

Get the number of 'Verification' element items.

Returns:

count

addVerification

public void addVerification(Verification item)

Add a 'Verification' element item.

Parameters:

item -

getVerification

public Verification getVerification(int index)

Get 'Verification' element item by position.

Parameters:

index -

Returns:

item

clearVerifications

public void clearVerifications()

Remove all 'Verification' element items.

getSegments

public java.util.List<CancelRQ.Segment> getSegments()

Get the list of 'Segment' element items.

Returns:

list

setSegments

public void setSegments(java.util.List<CancelRQ.Segment> list)

Set the list of 'Segment' element items.

Parameters:

list -

sizeSegments

public int sizeSegments()

Get the number of 'Segment' element items.

Returns:

count

addSegment

public void addSegment(CancelRQ.Segment item)

Add a 'Segment' element item.

Parameters:

item -

getSegment

public CancelRQ.Segment getSegment(int index)

Get 'Segment' element item by position.

Parameters:

index -

Returns:

item

clearSegments

public void clearSegments()

Remove all 'Segment' element items.

getCancellationOverride

public CancelRule getCancellationOverride()

Get the 'CancellationOverride' element value. Used to override a cancellation rule.

Returns:

value

setCancellationOverride

public void setCancellationOverride(CancelRule cancellationOverride)

Set the 'CancellationOverride' element value. Used to override a cancellation rule.

Parameters:

cancellationOverride -

getReasons

public CancelRQ.Reasons getReasons()

Get the 'Reasons' element value.

Returns:

value

setReasons

public void setReasons(CancelRQ.Reasons reasons)

Set the 'Reasons' element value.

Parameters:

reasons -

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 -

getPayloadStdAttributes

public OTAPayloadStdAttributes getPayloadStdAttributes()

Get the 'OTA_PayloadStdAttributes' attributeGroup value.

Returns:

value

setPayloadStdAttributes

public void setPayloadStdAttributes(OTAPayloadStdAttributes payloadStdAttributes)

Set the 'OTA_PayloadStdAttributes' attributeGroup value.

Parameters:

payloadStdAttributes -

getReqRespVersion

public java.lang.String getReqRespVersion()

Get the 'ReqRespVersion' attribute value. Used to request the version of the payload message desired for the response.

Returns:

value

setReqRespVersion

public void setReqRespVersion(java.lang.String reqRespVersion)

Set the 'ReqRespVersion' attribute value. Used to request the version of the payload message desired for the response.

Parameters:

reqRespVersion -

getCancel

public TransactionAction getCancel()

Get the 'CancelType' attribute value.

Returns:

value

setCancel

public void setCancel(TransactionAction cancel)

Set the 'CancelType' attribute value.

Parameters:

cancel -

getTravelSector

public java.lang.String getTravelSector()

Get the 'TravelSector' attribute value. The travel segment type to be cancelled. Refer to OpenTravel Codelist Travel Sector (TVS).

Returns:

value

setTravelSector

public void setTravelSector(java.lang.String travelSector)

Set the 'TravelSector' attribute value. The travel segment type to be cancelled. Refer to OpenTravel Codelist Travel Sector (TVS).

Parameters:

travelSector -