com.hybris.cockpitng.actions

Class ActionStubExample

java.lang.Object

com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

com.hybris.cockpitng.actions.ActionStubExample

All Implemented Interfaces:

CockpitAction<String,String>, ComponentWidgetAdapterAware

public class ActionStubExample
extends AbstractComponentWidgetAdapterAware
implements CockpitAction<String,String>

An action that shows the data bound to the action.

Constructor Summary

Constructors

Constructor and Description
ActionStubExample()

Method Summary

Modifier and Type	Method and Description
boolean	canPerform(ActionContext<String> ctx) Returns true if the action can be performed for the given context, false otherwise.
String	getConfirmationMessage(ActionContext<String> ctx) Returns the confirmation message to be shown to the user in the confirmation dialog if confirmation is needed (see CockpitAction.needsConfirmation(ActionContext)).
boolean	needsConfirmation(ActionContext<String> ctx) Returns true if the action should be confirmed by user before being performed, false otherwise.
ActionResult<String>	perform(ActionContext<String> ctx) Performs the action.

Methods inherited from class com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

addSocketInputEventListener, getComponentID, handleSocketInputEvent, initialize, initializeDefaultEventListeners, registerStubInstance, sendOutput, setComponentID, unregisterStubInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionStubExample

public ActionStubExample()

Method Detail

perform

public ActionResult<String> perform(ActionContext<String> ctx)

Description copied from interface: CockpitAction

Performs the action.

Specified by:

perform in interface CockpitAction<String,String>

Parameters:

ctx - context containing the data and other information

Returns:

the action result

canPerform

public boolean canPerform(ActionContext<String> ctx)

Description copied from interface: CockpitAction

Returns true if the action can be performed for the given context, false otherwise.

Specified by:

canPerform in interface CockpitAction<String,String>

Parameters:

ctx - context containing the data and other information

Returns:

true if the action can be performed for the given context, false otherwise

needsConfirmation

public boolean needsConfirmation(ActionContext<String> ctx)

Description copied from interface: CockpitAction

Returns true if the action should be confirmed by user before being performed, false otherwise. This is evaluated by the action renderer.

Specified by:

needsConfirmation in interface CockpitAction<String,String>

Parameters:

ctx - context containing the data and other information

Returns:

true if the action should be confirmed by user before being performed, false otherwise

getConfirmationMessage

public String getConfirmationMessage(ActionContext<String> ctx)

Description copied from interface: CockpitAction

Returns the confirmation message to be shown to the user in the confirmation dialog if confirmation is needed (see CockpitAction.needsConfirmation(ActionContext)).

Specified by:

getConfirmationMessage in interface CockpitAction<String,String>

Parameters:

ctx - context containing the data and other information

Returns:

the confirmation message to be shown to the user in the confirmation dialog

See Also:

CockpitAction.needsConfirmation(ActionContext)