co.aurasphere.botmill.fb.model.outcoming.factory

Class BoardingPassBuilder

java.lang.Object

co.aurasphere.botmill.fb.bean.FbBotMillBean

co.aurasphere.botmill.fb.model.outcoming.factory.FbBotMillResponseBuilder

co.aurasphere.botmill.fb.model.outcoming.factory.TemplateBaseBuilder

co.aurasphere.botmill.fb.model.outcoming.factory.AirlineBaseTemplateBuilder

co.aurasphere.botmill.fb.model.outcoming.factory.FlightInfoBuilderDelegator

co.aurasphere.botmill.fb.model.outcoming.factory.BoardingPassBuilder

public class BoardingPassBuilder
extends FlightInfoBuilderDelegator

Builder for a BoardingPass object.

Author:

Donato Rimenti

Field Summary

Fields inherited from class co.aurasphere.botmill.fb.model.outcoming.factory.TemplateBaseBuilder

messageBuilder

Method Summary

Modifier and Type	Method and Description
BoardingPassBuilder	addAuxiliaryField(Field auxiliaryField) Adds an auxiliary field for the current BoardingPass object.
BoardingPassBuilder	addAuxiliaryField(String label, String value) Adds an auxiliary field for the current BoardingPass object.
FlightInfoBuilder<BoardingPassBuilder>	addFlightInfo(String flightNumber) Adds a FlightInfo object to this BoardingPass.
BoardingPassBuilder	addSecondaryField(Field secondaryField) Adds a secondary field for the current BoardingPass object.
BoardingPassBuilder	addSecondaryField(String label, String value) Adds a secondary field for the current BoardingPass object.
AirlineBoardingPassTemplateBuilder	endBoardingPass() Builds the current object, adds it to the parent builder and returns the parent builder.
BoardingPassBuilder	setBarcodeImageUrl(String barcodeImageUrl) Sets the URL of the barcode image for the current BoardingPass object.
BoardingPassBuilder	setHeaderImageUrl(String headerImageUrl) Sets the header image URL for the current BoardingPass object.
BoardingPassBuilder	setHeaderTextField(String headerTextField) Sets the header text for the current BoardingPass object.
BoardingPassBuilder	setQrCode(String qrCode) Sets the Aztec or QR code for the current BoardingPass object.
BoardingPassBuilder	setSeat(String seat) Sets the seat for the current BoardingPass object.
BoardingPassBuilder	setTravelClass(TravelClass travelClass) Sets the TravelClass for the current BoardingPass object.
String	toString()

Methods inherited from class co.aurasphere.botmill.fb.model.outcoming.factory.FbBotMillResponseBuilder

getRecipient

Methods inherited from class co.aurasphere.botmill.fb.bean.FbBotMillBean

eventKind, getAudioMessage, getFileMessage, getImageMessage, getLocationMessage, getVideoMessage, safeGetMessage, safeGetPostbackPayload, safeGetQuickReplyPayload, safeGetRecipient, safeGetRecipientId, safeGetSender, safeGetSenderId, validate

Methods inherited from class java.lang.Object

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

Method Detail

setTravelClass

public BoardingPassBuilder setTravelClass(TravelClass travelClass)

Sets the TravelClass for the current BoardingPass object. This field is optional.

Parameters:

travelClass - the travel class to set.

Returns:

this builder.

setSeat

public BoardingPassBuilder setSeat(String seat)

Sets the seat for the current BoardingPass object. This field is optional.

Parameters:

seat - the seat to set.

Returns:

this builder.

addAuxiliaryField

public BoardingPassBuilder addAuxiliaryField(String label,
                                             String value)

Adds an auxiliary field for the current BoardingPass object. This field is optional. There can be at most 5 auxiliary fields per boarding pass.

Parameters:

label - the label for the additional field. It can't be empty.

value - the value for the additional field. It can't be empty.

Returns:

this builder.

addAuxiliaryField

public BoardingPassBuilder addAuxiliaryField(Field auxiliaryField)

Adds an auxiliary field for the current BoardingPass object. This field is optional. There can be at most 5 auxiliary fields per boarding pass.

Parameters:

auxiliaryField - the field to add. It can't be null.

Returns:

this builder.

addSecondaryField

public BoardingPassBuilder addSecondaryField(String label,
                                             String value)

Adds a secondary field for the current BoardingPass object. This field is optional. There can be at most 5 secondary fields per boarding pass.

Parameters:

label - the label for the additional field. It can't be empty.

value - the value for the additional field. It can't be empty.

Returns:

this builder.

addSecondaryField

public BoardingPassBuilder addSecondaryField(Field secondaryField)

Adds a secondary field for the current BoardingPass object. This field is optional. There can be at most 5 secondary fields per boarding pass.

Parameters:

secondaryField - the field to add. It can't be null.

Returns:

this builder.

setHeaderImageUrl

public BoardingPassBuilder setHeaderImageUrl(String headerImageUrl)

Sets the header image URL for the current BoardingPass object. This field is optional.

Parameters:

headerImageUrl - the URL of the header image.

Returns:

the boarding pass builder

setHeaderTextField

public BoardingPassBuilder setHeaderTextField(String headerTextField)

Sets the header text for the current BoardingPass object. This field is optional.

Parameters:

headerTextField - the text of the header.

Returns:

the boarding pass builder

setQrCode

public BoardingPassBuilder setQrCode(String qrCode)

Sets the Aztec or QR code for the current BoardingPass object. This field or the barcode image URL must be set.

Parameters:

qrCode - the Aztec or QR code. It can't be empty unless the barcode image URL is set.

Returns:

the boarding pass builder

See Also:

setBarcodeImageUrl(String)

setBarcodeImageUrl

public BoardingPassBuilder setBarcodeImageUrl(String barcodeImageUrl)

Sets the URL of the barcode image for the current BoardingPass object. This field or the QR code must be set.

Parameters:

barcodeImageUrl - the URL of the barcode image. It can't be empty unless the QR code is set.

Returns:

the boarding pass builder

See Also:

setQrCode(String)

addFlightInfo

public FlightInfoBuilder<BoardingPassBuilder> addFlightInfo(String flightNumber)

Adds a FlightInfo object to this BoardingPass. This object is mandatory and can't be null for Airline templates.

Parameters:

flightNumber - the flight number. It can't be empty.

Returns:

a builder for the FlightInfo object.

endBoardingPass

public AirlineBoardingPassTemplateBuilder endBoardingPass()

Builds the current object, adds it to the parent builder and returns the parent builder.

Returns:

the parent builder of this builder.

toString

public String toString()

Overrides:

toString in class FlightInfoBuilderDelegator