org.apache.taglibs.rdc.sampleapps.musicstore
Class MusicStoreAppBean

java.lang.Object
  org.apache.taglibs.rdc.sampleapps.musicstore.MusicStoreAppBean

public class MusicStoreAppBean
extends java.lang.Object

The application bean for the sample music store application

Author:

Rahul Akolkar, Thomas Ling

Field Summary

static java.lang.String	GUI_APP GUI channel
static java.lang.String	SESSION_KEY The key used to save application state in the HttpSession
static java.lang.String	VOICE_APP Voice channel
static java.lang.String	VOICE_DBG Voice Debug channel

Constructor Summary

MusicStoreAppBean(java.lang.String subscriptionId)
MusicStoreAppBean Constructor

Method Summary

MusicAlbum[]	getAlbums() Get the array of albums that are the result set of the user's current query
Cart	getCart() Get the shopping cart object for this session
java.lang.String	getChannel() Get the application channel
java.lang.String	getCheckoutPrompt() Get the check out prompt
java.lang.String	getChoice() Get the readable query string
MusicAlbum	getCurrentAlbum() Get the album the user is currently interacting with
java.lang.String	getErrorDescription() Get the error description string
HTMLMenuLinks	getMenuLinks() Get the menu links object
AmazonMenuTemplate.AmazonMenuResult	getMenuResult() Get the user's main menu selection
MusicStore	getMusicStore() Get the music store object
SelectOne.Options	getOptions() Get the result set of the user's query as <rdc:select1> options
ProactiveHelp	getProactiveHelp() Get the proactive help bean
java.lang.String	getSESSION_KEY()
void	setAlbums(MusicAlbum[] albums) Set the result set of the user's current query
void	setCart(Cart cart) Set the shopping cart object for this session
void	setChannel(java.lang.String channel) Set the channel of the application
void	setCheckoutPrompt(java.lang.String checkoutPrompt) Set the check out prompt
void	setChoice(java.lang.String choice) Set the readable query string
void	setCurrentAlbum(MusicAlbum currentAlbum) Set the album the user is currently interacting with
void	setErrorDescription(java.lang.String errorDescription) Set the error description string
void	setMenuLinks(HTMLMenuLinks menuLinks) Set the menuLinks bean for Links generation
void	setMenuResult(AmazonMenuTemplate.AmazonMenuResult menuResult) Set the user's main menu selection data
void	setOptions(SelectOne.Options options) Set the result set of the user's query as <rdc:select1> options
void	setProactiveHelp(ProactiveHelp proactiveHelp) Set the proactive help bean for this session

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_KEY

public static final java.lang.String SESSION_KEY

The key used to save application state in the HttpSession

See Also:

Constant Field Values

GUI_APP

public static final java.lang.String GUI_APP

GUI channel

See Also:

Constant Field Values

VOICE_APP

public static final java.lang.String VOICE_APP

Voice channel

See Also:

Constant Field Values

VOICE_DBG

public static final java.lang.String VOICE_DBG

Voice Debug channel

See Also:

Constant Field Values

Constructor Detail

MusicStoreAppBean

public MusicStoreAppBean(java.lang.String subscriptionId)

MusicStoreAppBean Constructor

Method Detail

getSESSION_KEY

public java.lang.String getSESSION_KEY()

getMenuResult

public AmazonMenuTemplate.AmazonMenuResult getMenuResult()

Get the user's main menu selection

Returns:

the AmazonMenuTemplate.AmazonMenuResult object corresponding to the main menu selection

getAlbums

public MusicAlbum[] getAlbums()

Get the array of albums that are the result set of the user's current query

Returns:

The array of albums that are the result set of the user's current query

getChoice

public java.lang.String getChoice()

Get the readable query string

Returns:

choice the readable query string

getOptions

public SelectOne.Options getOptions()

Get the result set of the user's query as <rdc:select1> options

Returns:

options the SelectOne.Options object

getCurrentAlbum

public MusicAlbum getCurrentAlbum()

Get the album the user is currently interacting with

Returns:

currentAlbum the MusicAlbum the user is currently interacting with

getCart

public Cart getCart()

Get the shopping cart object for this session

Returns:

cart the shopping cart object

getErrorDescription

public java.lang.String getErrorDescription()

Get the error description string

Returns:

errorDescription the error description string

getProactiveHelp

public ProactiveHelp getProactiveHelp()

Get the proactive help bean

Returns:

proactiveHelp the proactive help bean

getCheckoutPrompt

public java.lang.String getCheckoutPrompt()

Get the check out prompt

Returns:

checkoutPrompt the check out prompt

getMusicStore

public MusicStore getMusicStore()

Get the music store object

Returns:

MusicStore The music store object

getMenuLinks

public HTMLMenuLinks getMenuLinks()

Get the menu links object

Returns:

HTMLMenuLinks The menu links object

getChannel

public java.lang.String getChannel()

Get the application channel

Returns:

channel The channel key

setMenuResult

public void setMenuResult(AmazonMenuTemplate.AmazonMenuResult menuResult)

Set the user's main menu selection data

Parameters:

menuResult - the AmazonMenuTemplate.AmazonMenuResult object corresponding to the main menu selection

setAlbums

public void setAlbums(MusicAlbum[] albums)

Set the result set of the user's current query

Parameters:

albums - The array of albums that are the result set of the user's current query

setChoice

public void setChoice(java.lang.String choice)

Set the readable query string

Parameters:

choice - the readable query string

setOptions

public void setOptions(SelectOne.Options options)

Set the result set of the user's query as <rdc:select1> options

Parameters:

options - the SelectOne.Options object

setCurrentAlbum

public void setCurrentAlbum(MusicAlbum currentAlbum)

Set the album the user is currently interacting with

Parameters:

currentAlbum - the MusicAlbum the user is currently interacting with

setCart

public void setCart(Cart cart)

Set the shopping cart object for this session

Parameters:

cart - the shopping cart object

setErrorDescription

public void setErrorDescription(java.lang.String errorDescription)

Set the error description string

Parameters:

errorDescription - the error description string

setProactiveHelp

public void setProactiveHelp(ProactiveHelp proactiveHelp)

Set the proactive help bean for this session

Parameters:

proactiveHelp - the proactive help bean

setCheckoutPrompt

public void setCheckoutPrompt(java.lang.String checkoutPrompt)

Set the check out prompt

Parameters:

checkoutPrompt - the check out prompt

setMenuLinks

public void setMenuLinks(HTMLMenuLinks menuLinks)

Set the menuLinks bean for Links generation

Parameters:

menuLinks - The menuLinks to set.

setChannel

public void setChannel(java.lang.String channel)

Set the channel of the application

Parameters:

channel - the application channel