org.ota.misc
Class CancelRS

java.lang.Object
  org.ota.misc.CancelRS

public class CancelRS
extends java.lang.Object

Used to respond to a CancelRQ and may provide details about the cancellation. 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_CancelRS">
   <xs:complexType>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
         <xs:element type="ns:UniqueID_Type" name="UniqueID" minOccurs="0" maxOccurs="5"/>
         <xs:element type="ns:CancelInfoRSType" name="CancelInfoRS" minOccurs="0"/>
         <xs:element type="ns:ParagraphType" name="Comment" minOccurs="0"/>
         <xs:element name="Segment" minOccurs="0" maxOccurs="99">
           <!-- Reference to inner class Segment -->
         </xs:element>
         <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
       </xs:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attribute type="ns:TransactionStatusType" use="required" name="Status"/>
   </xs:complexType>
 </xs:element>
 
 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="SuccessType"/>
 
 <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

CancelRS.Segment Used to specify a segment that has been cancelled.

Constructor Summary

CancelRS()

Method Summary

void	addSegment(CancelRS.Segment item) Add a 'Segment' element item.
void	addUniqueID(UniqueID item) Add a 'UniqueID' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearSegments() Remove all 'Segment' element items.
void	clearUniqueIDs() Remove all 'UniqueID' element items.
CancelInfoRS	getCancelInfoRS() Get the 'CancelInfoRS' element value.
Paragraph	getComment() Get the 'Comment' element value.
Errors	getErrors() Get the 'Errors' element value.
OTAPayloadStdAttributes	getPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
CancelRS.Segment	getSegment(int index) Get 'Segment' element item by position.
java.util.List<CancelRS.Segment>	getSegments() Get the list of 'Segment' element items.
TransactionStatus	getStatus() Get the 'Status' attribute value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
UniqueID	getUniqueID(int index) Get 'UniqueID' element item by position.
java.util.List<UniqueID>	getUniqueIDs() Get the list of 'UniqueID' element items.
Warnings	getWarnings() Get the 'Warnings' element value.
boolean	ifErrors() Check if Errors is current selection for choice.
boolean	ifSuccess() Check if Success is current selection for choice.
void	setCancelInfoRS(CancelInfoRS cancelInfoRS) Set the 'CancelInfoRS' element value.
void	setComment(Paragraph comment) Set the 'Comment' element value.
void	setErrors(Errors errors) Set the 'Errors' element value.
void	setPayloadStdAttributes(OTAPayloadStdAttributes payloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setSegments(java.util.List<CancelRS.Segment> list) Set the list of 'Segment' element items.
void	setStatus(TransactionStatus status) Set the 'Status' attribute value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setUniqueIDs(java.util.List<UniqueID> list) Set the list of 'UniqueID' element items.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
int	sizeSegments() Get the number of 'Segment' element items.
int	sizeUniqueIDs() Get the number of 'UniqueID' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelRS

public CancelRS()

Method Detail

clearChoiceSelect

public void clearChoiceSelect()

Clear the choice selection.

ifSuccess

public boolean ifSuccess()

Check if Success is current selection for choice.

Returns:

true if selection, false if not

getWarnings

public Warnings getWarnings()

Get the 'Warnings' element value. Used in conjunction with the success element to define one or more business errors.

Returns:

value

setWarnings

public void setWarnings(Warnings warnings)

Set the 'Warnings' element value. Used in conjunction with the success element to define one or more business errors.

Parameters:

warnings -

getUniqueIDs

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

Get the list of 'UniqueID' element items. Contains the reference(s) of the items being cancelled.

Returns:

list

setUniqueIDs

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

Set the list of 'UniqueID' element items. Contains the reference(s) of the items being cancelled.

Parameters:

list -

sizeUniqueIDs

public int sizeUniqueIDs()

Get the number of 'UniqueID' element items.

Returns:

count

addUniqueID

public void addUniqueID(UniqueID item)

Add a 'UniqueID' element item.

Parameters:

item -

getUniqueID

public UniqueID getUniqueID(int index)

Get 'UniqueID' element item by position.

Parameters:

index -

Returns:

item

clearUniqueIDs

public void clearUniqueIDs()

Remove all 'UniqueID' element items.

getCancelInfoRS

public CancelInfoRS getCancelInfoRS()

Get the 'CancelInfoRS' element value. May contain rules associated with canceling a reservation as well as the supplier's cancellation number.

Returns:

value

setCancelInfoRS

public void setCancelInfoRS(CancelInfoRS cancelInfoRS)

Set the 'CancelInfoRS' element value. May contain rules associated with canceling a reservation as well as the supplier's cancellation number.

Parameters:

cancelInfoRS -

getComment

public Paragraph getComment()

Get the 'Comment' element value. Textual information regarding the cancellation.

Returns:

value

setComment

public void setComment(Paragraph comment)

Set the 'Comment' element value. Textual information regarding the cancellation.

Parameters:

comment -

getSegments

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

Get the list of 'Segment' element items.

Returns:

list

setSegments

public void setSegments(java.util.List<CancelRS.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(CancelRS.Segment item)

Add a 'Segment' element item.

Parameters:

item -

getSegment

public CancelRS.Segment getSegment(int index)

Get 'Segment' element item by position.

Parameters:

index -

Returns:

item

clearSegments

public void clearSegments()

Remove all 'Segment' 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 -

ifErrors

public boolean ifErrors()

Check if Errors is current selection for choice.

Returns:

true if selection, false if not

getErrors

public Errors getErrors()

Get the 'Errors' element value.

Returns:

value

setErrors

public void setErrors(Errors errors)

Set the 'Errors' element value.

Parameters:

errors -

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 -

getStatus

public TransactionStatus getStatus()

Get the 'Status' attribute value.

Returns:

value

setStatus

public void setStatus(TransactionStatus status)

Set the 'Status' attribute value.

Parameters:

status -