com.hybris.cockpitng.actions

Class ActionResult<O>

java.lang.Object

com.hybris.cockpitng.actions.ActionResult<O>

Type Parameters:

O - output type of the action

public class ActionResult<O>
extends Object

Result object of a cockpit action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionResult.StatusFlag

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR Result code for error.
static String	SUCCESS Result code for success.

Constructor Summary

Constructors

Constructor and Description
ActionResult(String resultCode) Constructor with a result code.
ActionResult(String resultCode, O data) Constructor with a result code and data.

Method Summary

Modifier and Type	Method and Description
void	addOutputSocketToSend(String outputId, Object outputData) Adds data to be sent to the output socket with the given ID after the action has performed.
void	addSocketAfterOperation(BackgroundOperationDefinition definition) Registers a background operation.
O	getData() Returns the output data returned by the performed action.
Map<String,Object>	getOutputsToSend() Returns socket outputs and data to be sent after the action is has performed.
String	getResultCode() Returns the result code of the action.
String	getResultMessage() Returns the result message.
List<BackgroundOperationDefinition>	getSocketAfterOperation() Retuns all background operations.
EnumSet<ActionResult.StatusFlag>	getStatusFlags()
void	setData(O data) Sets the output data of the performed action.
void	setResultCode(String resultCode) Sets the result code of the action.
void	setResultMessage(String resultMessage) Sets the result message.
void	setStatusFlags(EnumSet<ActionResult.StatusFlag> statusFlags)

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final String SUCCESS

Result code for success. Means that the action was performed successfully.

See Also:

Constant Field Values

ERROR

public static final String ERROR

Result code for error. Means that the action was not performed successfully because of an error.

See Also:

Constant Field Values

Constructor Detail

ActionResult

public ActionResult(String resultCode)

Constructor with a result code.

Parameters:

resultCode - the result code of the action

See Also:

SUCCESS, ERROR

ActionResult

public ActionResult(String resultCode,
                    O data)

Constructor with a result code and data.

Parameters:

resultCode - the result code of the action

data - data to be returned

See Also:

SUCCESS, ERROR

Method Detail

getData

public O getData()

Returns the output data returned by the performed action.

Returns:

output data returned by the performed action

setData

public void setData(O data)

Sets the output data of the performed action.

Parameters:

data - output data of the performed action

getResultCode

public String getResultCode()

Returns the result code of the action.

Returns:

result code of the action

See Also:

SUCCESS, ERROR

setResultCode

public void setResultCode(String resultCode)

Sets the result code of the action.

Parameters:

resultCode - result code of the action

See Also:

SUCCESS, ERROR

getResultMessage

public String getResultMessage()

Returns the result message.

Returns:

result message

setResultMessage

public void setResultMessage(String resultMessage)

Sets the result message.

Parameters:

resultMessage - result message

getOutputsToSend

public Map<String,Object> getOutputsToSend()

Returns socket outputs and data to be sent after the action is has performed.

Returns:

socket outputs and data to be sent after the action is has performed. Key of the map is the socket ID, value contains the data to be sent.

addOutputSocketToSend

public void addOutputSocketToSend(String outputId,
                                  Object outputData)

Adds data to be sent to the output socket with the given ID after the action has performed.

Parameters:

outputId - output ID of the socket through which the data should be sent. It is a socket of the widget the action resides in.

outputData - the data to be sent

addSocketAfterOperation

public void addSocketAfterOperation(BackgroundOperationDefinition definition)

Registers a background operation.

Parameters:

definition - background operation

getSocketAfterOperation

public List<BackgroundOperationDefinition> getSocketAfterOperation()

Retuns all background operations.

Returns:

all background operations

getStatusFlags

public EnumSet<ActionResult.StatusFlag> getStatusFlags()

setStatusFlags

public void setStatusFlags(EnumSet<ActionResult.StatusFlag> statusFlags)