org.ota.screen
Class TextRS

java.lang.Object
  org.ota.screen.TextRS

public class TextRS
extends java.lang.Object

The free text response to a screen text request. The responder may return a screen of information in a block of unformatted data or return a screen of information in a line by line response. 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_ScreenTextRS">
   <xs:complexType>
     <xs:sequence>
       <xs:choice>
         <xs:sequence>
           <xs:element type="ns:SuccessType" name="Success"/>
           <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
         </xs:sequence>
         <xs:element type="ns:ErrorsType" name="Errors"/>
       </xs:choice>
       <xs:element name="TextScreens" minOccurs="0">
         <!-- Reference to inner class TextScreens -->
       </xs:element>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attribute type="xs:string" use="optional" name="MessageFunction"/>
   </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"/>
 

Nested Class Summary

static class

TextRS.TextScreens The container for the screens of text that will be returned.

Constructor Summary

TextRS()

Method Summary

void	clearChoiceSelect() Clear the choice selection.
Errors	getErrors() Get the 'Errors' element value.
java.lang.String	getMessageFunction() Get the 'MessageFunction' attribute value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
TextRS.TextScreens	getTextScreens() Get the 'TextScreens' element value.
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	setErrors(Errors errors) Set the 'Errors' element value.
void	setMessageFunction(java.lang.String messageFunction) Set the 'MessageFunction' attribute value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setTextScreens(TextRS.TextScreens textScreens) Set the 'TextScreens' element value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextRS

public TextRS()

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. Standard way to indicate successful processing of an OpenTravel message, but one in which warnings are generated.

Returns:

value

setWarnings

public void setWarnings(Warnings warnings)

Set the 'Warnings' element value. Standard way to indicate successful processing of an OpenTravel message, but one in which warnings are generated.

Parameters:

warnings -

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. A collection of errors that occurred during the processing of a message.

Returns:

value

setErrors

public void setErrors(Errors errors)

Set the 'Errors' element value. A collection of errors that occurred during the processing of a message.

Parameters:

errors -

getTextScreens

public TextRS.TextScreens getTextScreens()

Get the 'TextScreens' element value.

Returns:

value

setTextScreens

public void setTextScreens(TextRS.TextScreens textScreens)

Set the 'TextScreens' element value.

Parameters:

textScreens -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()

Get the 'OTA_PayloadStdAttributes' attributeGroup value.

Returns:

value

setOTAPayloadStdAttributes

public void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)

Set the 'OTA_PayloadStdAttributes' attributeGroup value.

Parameters:

OTAPayloadStdAttributes -

getMessageFunction

public java.lang.String getMessageFunction()

Get the 'MessageFunction' attribute value. To specify the message function that is being responded to.

Returns:

value

setMessageFunction

public void setMessageFunction(java.lang.String messageFunction)

Set the 'MessageFunction' attribute value. To specify the message function that is being responded to.

Parameters:

messageFunction -