org.ota.shared
Class FormattedText.SubSection

java.lang.Object
  org.ota.shared.FormattedText.SubSection

Enclosing class:

FormattedText

public static class FormattedText.SubSection
extends java.lang.Object

Subsection formatted text information. 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" type="ns:FormattedTextSubSectionType" name="SubSection" maxOccurs="99"/>
 
 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="FormattedTextSubSectionType">
   <xs:sequence>
     <xs:element type="ns:ParagraphType" name="Paragraph" maxOccurs="99"/>
   </xs:sequence>
   <xs:attribute type="xs:string" use="optional" name="SubTitle"/>
   <xs:attribute type="xs:string" use="optional" name="SubCode"/>
   <xs:attribute type="xs:int" use="optional" name="SubSectionNumber"/>
 </xs:complexType>
 

Constructor Summary

FormattedText.SubSection()

Method Summary

void	addParagraph(Paragraph item) Add a 'Paragraph' element item.
void	clearParagraphs() Remove all 'Paragraph' element items.
Paragraph	getParagraph(int index) Get 'Paragraph' element item by position.
java.util.List<Paragraph>	getParagraphs() Get the list of 'Paragraph' element items.
java.lang.String	getSubCode() Get the 'SubCode' attribute value.
java.lang.Integer	getSubSectionNumber() Get the 'SubSectionNumber' attribute value.
java.lang.String	getSubTitle() Get the 'SubTitle' attribute value.
void	setParagraphs(java.util.List<Paragraph> list) Set the list of 'Paragraph' element items.
void	setSubCode(java.lang.String subCode) Set the 'SubCode' attribute value.
void	setSubSectionNumber(java.lang.Integer subSectionNumber) Set the 'SubSectionNumber' attribute value.
void	setSubTitle(java.lang.String subTitle) Set the 'SubTitle' attribute value.
int	sizeParagraphs() Get the number of 'Paragraph' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattedText.SubSection

public FormattedText.SubSection()

Method Detail

getParagraphs

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

Get the list of 'Paragraph' element items. Details and content of a paragraph for a formatted text message.

Returns:

list

setParagraphs

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

Set the list of 'Paragraph' element items. Details and content of a paragraph for a formatted text message.

Parameters:

list -

sizeParagraphs

public int sizeParagraphs()

Get the number of 'Paragraph' element items.

Returns:

count

addParagraph

public void addParagraph(Paragraph item)

Add a 'Paragraph' element item.

Parameters:

item -

getParagraph

public Paragraph getParagraph(int index)

Get 'Paragraph' element item by position.

Parameters:

index -

Returns:

item

clearParagraphs

public void clearParagraphs()

Remove all 'Paragraph' element items.

getSubTitle

public java.lang.String getSubTitle()

Get the 'SubTitle' attribute value. This attribute may be used to provide a title for a sub-section of the formatted free text. A sub-section may have multiple related paragraphs of information. For example, if used to provide driving directions there may be multiple paragraphs, and these paragraphs may be grouped into a sub-section called "Driving from the North". A second subsection may be titled "Driving from the South", and may contain several paragraphs to describe the driving directions when driving from the south.

Returns:

value

setSubTitle

public void setSubTitle(java.lang.String subTitle)

Set the 'SubTitle' attribute value. This attribute may be used to provide a title for a sub-section of the formatted free text. A sub-section may have multiple related paragraphs of information. For example, if used to provide driving directions there may be multiple paragraphs, and these paragraphs may be grouped into a sub-section called "Driving from the North". A second subsection may be titled "Driving from the South", and may contain several paragraphs to describe the driving directions when driving from the south.

Parameters:

subTitle -

getSubCode

public java.lang.String getSubCode()

Get the 'SubCode' attribute value. An optional code that may be assigned to this sub-section of formatted free text.

Returns:

value

setSubCode

public void setSubCode(java.lang.String subCode)

Set the 'SubCode' attribute value. An optional code that may be assigned to this sub-section of formatted free text.

Parameters:

subCode -

getSubSectionNumber

public java.lang.Integer getSubSectionNumber()

Get the 'SubSectionNumber' attribute value. This attribute may be used when there is a need to number all of the sub-sections of information that is to be presented.

Returns:

value

setSubSectionNumber

public void setSubSectionNumber(java.lang.Integer subSectionNumber)

Set the 'SubSectionNumber' attribute value. This attribute may be used when there is a need to number all of the sub-sections of information that is to be presented.

Parameters:

subSectionNumber -