de.hybris.platform.hmc.util.action

Class ActionResult

java.lang.Object

de.hybris.platform.hmc.util.action.ActionResult

All Implemented Interfaces:

Serializable

public class ActionResult
extends Object
implements Serializable

ActionResult. Result of an hmc action.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCELLED result constant 'CANCELLED' - action cancelled (by user).
static int	FAILED Result constant 'FAILED' - action not performed successfully - an error occured.
protected static Logger	LOG
static int	OK Result constant 'OK' - action performed successfully.

Constructor Summary

Constructors

Constructor and Description
ActionResult(int result, boolean needRefresh)
ActionResult(int result, boolean needRefresh, boolean showResult)
ActionResult(int result, String message, boolean needRefresh)
ActionResult(int result, String message, boolean needRefresh, boolean showResult)

Method Summary

Modifier and Type	Method and Description
void	addMessage(String message)
String	getMessage()
List	getMessages() Returns the list of messages which should be shown to the user after action.
Object	getObject()
int	getResult() Returns the result code.
boolean	needRefresh() If true, the item editor will be refreshed to show possible changes on the item perfomed by the action.
void	setObject(Object object)
void	setResult(int result)
void	setShowResult(boolean show)
boolean	showResult() If true, the popup window with the result will be shown.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

OK

public static final int OK

Result constant 'OK' - action performed successfully.

See Also:

Constant Field Values

FAILED

public static final int FAILED

Result constant 'FAILED' - action not performed successfully - an error occured. Message contains error description.

See Also:

Constant Field Values

CANCELLED

public static final int CANCELLED

result constant 'CANCELLED' - action cancelled (by user).

See Also:

Constant Field Values

Constructor Detail

ActionResult

public ActionResult(int result,
                    String message,
                    boolean needRefresh)

ActionResult

public ActionResult(int result,
                    boolean needRefresh)

ActionResult

public ActionResult(int result,
                    boolean needRefresh,
                    boolean showResult)

ActionResult

public ActionResult(int result,
                    String message,
                    boolean needRefresh,
                    boolean showResult)

Method Detail

getResult

public int getResult()

Returns the result code.

getMessages

public List getMessages()

Returns the list of messages which should be shown to the user after action.

getMessage

public String getMessage()

addMessage

public void addMessage(String message)

needRefresh

public boolean needRefresh()

If true, the item editor will be refreshed to show possible changes on the item perfomed by the action.

showResult

public boolean showResult()

If true, the popup window with the result will be shown.

setShowResult

public void setShowResult(boolean show)

setResult

public void setResult(int result)

Parameters:

result - The result to set.

getObject

public Object getObject()

setObject

public void setObject(Object object)