no.g9.client.core.controller

Class DialogCallBackValue

java.lang.Object

no.g9.client.core.controller.DialogCallBackValue

public class DialogCallBackValue
extends Object

Author:

ab

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DialogCallBackValue.Flag Enumerates possible flag values which can be used to signal the outcome of the invoked dialog.

Constructor Summary

Constructors

Constructor and Description
DialogCallBackValue(DialogController source, Object value) Creates a new call back value with the specified source and value, and a null opCode value.
DialogCallBackValue(DialogController source, Object value, Integer opCode) Creates a new call back value with the specified source, value and opCode
DialogCallBackValue(DialogController source, Object value, Integer opCode, Message message) Creates a new call back value with the specified source, value and opCode
DialogCallBackValue(DialogController source, Object value, Integer opCode, Message message, DialogCallBackValue.Flag flagValue) Creates a new call back value with the specified source, value and opCode

Method Summary

Modifier and Type	Method and Description
DialogCallBackValue.Flag	getFlagValue() Get the flag value used to indicate the outcome of this call back.
Message	getMessage() Get the dialog call back value message.
Integer	getOpCode()
<T extends DialogController> T	getSource()
<V> V	getValue() Returns the call back value.
void	setFlagValue(DialogCallBackValue.Flag flagValue) Set the flag value.
void	setMessage(Message message) Set the message of this call back.
void	setOpCode(Integer opCode) Set the op code of this call back.
void	setSource(DialogController source)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogCallBackValue

public DialogCallBackValue(DialogController source,
                           Object value)

Creates a new call back value with the specified source and value, and a null opCode value.

Parameters:

source - the source of the call back value, e.g. the dialog doing the call back.

value - the call back value.

DialogCallBackValue

public DialogCallBackValue(DialogController source,
                           Object value,
                           Integer opCode)

Creates a new call back value with the specified source, value and opCode

Parameters:

source - the source of the call back value, e.g. the dialog doing the call back.

value - the call back value.

opCode - the opCode

DialogCallBackValue

public DialogCallBackValue(DialogController source,
                           Object value,
                           Integer opCode,
                           Message message)

Creates a new call back value with the specified source, value and opCode

Parameters:

source - the source of the call back value, e.g. the dialog doing the call back.

value - the call back value.

opCode - the opCode

message - the message

DialogCallBackValue

public DialogCallBackValue(DialogController source,
                           Object value,
                           Integer opCode,
                           Message message,
                           DialogCallBackValue.Flag flagValue)

Creates a new call back value with the specified source, value and opCode

Parameters:

source - the source of the call back value, e.g. the dialog doing the call back.

value - the call back value.

opCode - the opCode

message - the message

flagValue - the flag value

Method Detail

getOpCode

public Integer getOpCode()

Returns:

the opCode

getSource

public <T extends DialogController> T getSource()

Type Parameters:

T - The dialog controller

Returns:

the source of the call back value, e.g. the dialog doing the call back.

Throws:

ClassCastException - if returned dialog controller does not match the expected dialog controller.

getValue

public <V> V getValue()

Returns the call back value. The call back value is set when creating a CallBackValue instance.

Type Parameters:

V - The expected value type.

Returns:

the return value.

Throws:

ClassCastException - if the returned type does not match the expected type.

getMessage

public Message getMessage()

Get the dialog call back value message.

Returns:

the message

getFlagValue

public DialogCallBackValue.Flag getFlagValue()

Get the flag value used to indicate the outcome of this call back.

Returns:

the flag value

setFlagValue

public void setFlagValue(DialogCallBackValue.Flag flagValue)

Set the flag value.

Parameters:

flagValue - the flag value

setOpCode

public void setOpCode(Integer opCode)

Set the op code of this call back.

Parameters:

opCode - the op code

setSource

public void setSource(DialogController source)

Parameters:

source - the source to set

setMessage

public void setMessage(Message message)

Set the message of this call back.

Parameters:

message - the message

toString

public String toString()

Overrides:

toString in class Object