com.six.timapi

Class ShowDialogRequest

java.lang.Object

com.six.timapi.ShowDialogRequest

public class ShowDialogRequest
extends Object

Contains configuration for show dialog request used by Terminal.showDialog(com.six.timapi.ShowDialogRequest) or Terminal.showDialogAsync(com.six.timapi.ShowDialogRequest).

Constructor Summary

Constructors

Constructor and Description
ShowDialogRequest() Create show dialog request.
ShowDialogRequest(ShowDialogRequest request) Create copy of show dialog request.

Method Summary

Modifier and Type	Method and Description
List<BrandBarBrand>	getBrandBar() Brand bar.
BrandMode	getBrandMode() Brand mode.
String	getLanguage() Language.
Map<Integer,String>	getPlaceholderItems() Map of placeholder items.
ResourceId	getResourceId() Resource identifier.
Map<ResourceParameterType,String>	getResourceParameters() Map of resource parameters.
Theme	getTheme() Theme.
int	getTimeout() Timeout in seconds.
void	setBrandBar(List<BrandBarBrand> brandBar) Set brand bar.
void	setBrandMode(BrandMode brandMode) Set brand mode.
void	setLanguage(String language) Set language.
void	setPlaceholderItems(Map<Integer,String> items) Set map of placeholder items.
void	setResourceId(ResourceId resourceId) Set resource identifier.
void	setResourceParameters(Map<ResourceParameterType,String> parameters) Set map of resource parameters.
void	setTheme(Theme theme) Set theme.
void	setTimeout(int timeout) Set timeout in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowDialogRequest

public ShowDialogRequest()

Create show dialog request.

ShowDialogRequest

public ShowDialogRequest(ShowDialogRequest request)

Create copy of show dialog request.

Method Detail

getBrandBar

public List<BrandBarBrand> getBrandBar()

Brand bar. Used if brand mode is BrandMode.SELECTED.

setBrandBar

public void setBrandBar(List<BrandBarBrand> brandBar)

Set brand bar. Used if brand mode is BrandMode.SELECTED.

Throws:

IllegalArgumentException - brandBar is null.

getBrandMode

public BrandMode getBrandMode()

Brand mode.

setBrandMode

public void setBrandMode(BrandMode brandMode)

Set brand mode.

Throws:

IllegalArgumentException - brandBarMode is null.

getResourceId

public ResourceId getResourceId()

Resource identifier.

setResourceId

public void setResourceId(ResourceId resourceId)

Set resource identifier.

Throws:

IllegalArgumentException - resourceId is null.

getTheme

public Theme getTheme()

Theme.

setTheme

public void setTheme(Theme theme)

Set theme.

Throws:

IllegalArgumentException - theme is null.

getTimeout

public int getTimeout()

Timeout in seconds.

setTimeout

public void setTimeout(int timeout)

Set timeout in seconds.

getLanguage

public String getLanguage()

Language. Can be null if not set.

setLanguage

public void setLanguage(String language)

Set language. Can be null if not set.

getPlaceholderItems

public Map<Integer,String> getPlaceholderItems()

Map of placeholder items. Maps placeholder number to value. Returned map can be safely modified.

setPlaceholderItems

public void setPlaceholderItems(Map<Integer,String> items)

Set map of placeholder items. Maps placeholder number to value. For example if the dialog description states "%0 %1" with placeholder description "0: Currency, 1: Amount" then set map like this: Map<Integer,String> placeholders = new HashMap<>(); placeholders.put(0, Currency.CHF.code); // CHF placeholders.put(1, "2500"); // 25.-- request.setPlaceholderItems(placeholders); Map can be safely modified after method returns.

getResourceParameters

public Map<ResourceParameterType,String> getResourceParameters()

Map of resource parameters. Maps resource parameter type to value.

setResourceParameters

public void setResourceParameters(Map<ResourceParameterType,String> parameters)

Set map of resource parameters. Maps resource parameter type to value.