org.kuali.rice.krad.web.form

Class DialogResponse

java.lang.Object

org.kuali.rice.krad.web.form.DialogResponse

All Implemented Interfaces:

Serializable

public class DialogResponse
extends Object
implements Serializable

Holds response data for a basic dialog that has been triggered from a server call.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	TRUE_VALUES

Constructor Summary

Constructors

Constructor and Description
DialogResponse() Default Constructor.
DialogResponse(String dialogId, String response, String explanation) Constructor taking dialog id, response, and explanation.

Method Summary

Modifier and Type	Method and Description
String	getDialogId() Id for the dialog whose response has been captured.
String	getExplanation() If the dialog contained an explanation field that binds to the generic form property, the value (if any) given by the user.
String	getResponse() String response for the dialog action (button) that was chosen.
boolean	getResponseAsBoolean() Returns the response for the dialog as a boolean.
void	setDialogId(String dialogId)
void	setExplanation(String explanation)
void	setResponse(String response)

Methods inherited from class java.lang.Object

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

Field Detail

TRUE_VALUES

protected static final String TRUE_VALUES

See Also:

Constant Field Values

Constructor Detail

DialogResponse

public DialogResponse()

Default Constructor.

DialogResponse

public DialogResponse(String dialogId,
                      String response,
                      String explanation)

Constructor taking dialog id, response, and explanation.

Method Detail

getDialogId

public String getDialogId()

Id for the dialog whose response has been captured.

Returns:

dialog id

setDialogId

public void setDialogId(String dialogId)

See Also:

getDialogId()

getResponse

public String getResponse()

String response for the dialog action (button) that was chosen.

Returns:

String dialog response

getResponseAsBoolean

public boolean getResponseAsBoolean()

Returns the response for the dialog as a boolean.

Returns:

boolean dialog response

See Also:

TRUE_VALUES

setResponse

public void setResponse(String response)

See Also:

getResponse()

getExplanation

public String getExplanation()

If the dialog contained an explanation field that binds to the generic form property, the value (if any) given by the user.

Note if the explanation field was found to a different model property, its contents will not be available here. It should be retrieved from the corresponding model property.

Returns:

string explanation value

setExplanation

public void setExplanation(String explanation)

See Also:

getExplanation()