Package com.hybris.cockpitng.actions.create

Class CreateAction

java.lang.Object

com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

com.hybris.cockpitng.actions.create.CreateAction

All Implemented Interfaces:

CockpitAction<java.lang.Object,java.lang.Object>, ComponentWidgetAdapterAware

public class CreateAction
extends AbstractComponentWidgetAdapterAware
implements CockpitAction<java.lang.Object,java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_ACTION_CONTEXT
static java.lang.String	SETTING_CONTEXT_COMPONENT_NAME
static java.lang.String	SETTING_INITIALIZE_ENTITY
static java.lang.String	SOCKET_INPUT_CREATED_OBJECT
static java.lang.String	SOCKET_OUTPUT_CREATE_CONTEXT
static java.lang.String	SOCKET_OUTPUT_CREATED_OBJECT
static java.lang.String	VALUE_SETTING_TARGET_COMPONENT_CONFIGURABLE_FLOW	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	VALUE_SETTING_TARGET_COMPONENT_EDITOR_AREA	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6

Constructor Summary

Constructors

Constructor	Description
CreateAction()

Method Summary

Modifier and Type	Method	Description
protected boolean	canCreateInstance(DataType type)
boolean	canPerform(ActionContext<java.lang.Object> ctx)	Returns true if the action can be performed for the given context, false otherwise.
protected java.lang.String	findTypeCode(ActionContext<java.lang.Object> ctx)
java.lang.String	getConfirmationMessage(ActionContext<java.lang.Object> ctx)	Returns the confirmation message to be shown to the user in the confirmation dialog if confirmation is needed (see CockpitAction.needsConfirmation(ActionContext)).
FieldSearchFacade	getFieldSearchFacade()
protected NotificationService	getNotificationService()
protected java.lang.String	getNotificationSource(ActionContext<java.lang.Object> ctx)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7, use NotificationService.getWidgetNotificationSource(ActionContext) instead.
ObjectFacade	getObjectFacade()
protected PermissionFacade	getPermissionFacade()
TypeFacade	getTypeFacade()
void	initializeDefaultEventListeners()	Initializes default socket event listeners for the component.
protected boolean	isAllowed(java.lang.String typeCode)
boolean	needsConfirmation(ActionContext<java.lang.Object> ctx)	Returns true if the action should be confirmed by user before being performed, false otherwise.
ActionResult<java.lang.Object>	perform(ActionContext<java.lang.Object> ctx)	Performs the action.
protected void	sendConfiguredOutput(ActionContext<java.lang.Object> ctx, java.lang.String typeCode)
void	setFieldSearchFacade(FieldSearchFacade fieldSearchFacade)
void	setNotificationService(NotificationService notificationService)
void	setObjectFacade(ObjectFacade objectFacade)
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setTypeFacade(TypeFacade typeFacade)
protected boolean	shouldInitializeEntity(ActionContext<java.lang.Object> ctx)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_OUTPUT_CREATE_CONTEXT

public static final java.lang.String SOCKET_OUTPUT_CREATE_CONTEXT

See Also:

Constant Field Values

SOCKET_OUTPUT_CREATED_OBJECT

public static final java.lang.String SOCKET_OUTPUT_CREATED_OBJECT

See Also:

Constant Field Values

SOCKET_INPUT_CREATED_OBJECT

public static final java.lang.String SOCKET_INPUT_CREATED_OBJECT

See Also:

Constant Field Values

SETTING_INITIALIZE_ENTITY

public static final java.lang.String SETTING_INITIALIZE_ENTITY

See Also:

Constant Field Values

SETTING_CONTEXT_COMPONENT_NAME

public static final java.lang.String SETTING_CONTEXT_COMPONENT_NAME

See Also:

Constant Field Values

VALUE_SETTING_TARGET_COMPONENT_CONFIGURABLE_FLOW

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String VALUE_SETTING_TARGET_COMPONENT_CONFIGURABLE_FLOW

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

VALUE_SETTING_TARGET_COMPONENT_EDITOR_AREA

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String VALUE_SETTING_TARGET_COMPONENT_EDITOR_AREA

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

PARAM_ACTION_CONTEXT

public static final java.lang.String PARAM_ACTION_CONTEXT

See Also:

Constant Field Values

Constructor Detail

CreateAction

public CreateAction()

Method Detail

perform

public ActionResult<java.lang.Object> perform(ActionContext<java.lang.Object> ctx)

Description copied from interface: CockpitAction

Performs the action.

Specified by:

perform in interface CockpitAction<java.lang.Object,java.lang.Object>

Parameters:

ctx - context containing the data and other information

Returns:

the action result

findTypeCode

protected java.lang.String findTypeCode(ActionContext<java.lang.Object> ctx)

getNotificationSource

@Deprecated(since="6.7",
            forRemoval=true)
protected java.lang.String getNotificationSource(ActionContext<java.lang.Object> ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7, use NotificationService.getWidgetNotificationSource(ActionContext) instead.

sendConfiguredOutput

protected void sendConfiguredOutput(ActionContext<java.lang.Object> ctx,
                                    java.lang.String typeCode)
                             throws ObjectCreationException

Throws:

ObjectCreationException

shouldInitializeEntity

protected boolean shouldInitializeEntity(ActionContext<java.lang.Object> ctx)

initializeDefaultEventListeners

public void initializeDefaultEventListeners()

Description copied from interface: ComponentWidgetAdapterAware

Initializes default socket event listeners for the component.

Specified by:

initializeDefaultEventListeners in interface ComponentWidgetAdapterAware

Overrides:

initializeDefaultEventListeners in class AbstractComponentWidgetAdapterAware

canPerform

public boolean canPerform(ActionContext<java.lang.Object> 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<java.lang.Object,java.lang.Object>

Parameters:

ctx - context containing the data and other information

Returns:

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

isAllowed

protected boolean isAllowed(java.lang.String typeCode)

canCreateInstance

protected boolean canCreateInstance(DataType type)

needsConfirmation

public boolean needsConfirmation(ActionContext<java.lang.Object> 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<java.lang.Object,java.lang.Object>

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 java.lang.String getConfirmationMessage(ActionContext<java.lang.Object> 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<java.lang.Object,java.lang.Object>

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)

getPermissionFacade

protected PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)

getTypeFacade

public TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getObjectFacade

public ObjectFacade getObjectFacade()

setObjectFacade

public void setObjectFacade(ObjectFacade objectFacade)

getFieldSearchFacade

public FieldSearchFacade getFieldSearchFacade()

setFieldSearchFacade

public void setFieldSearchFacade(FieldSearchFacade fieldSearchFacade)

getNotificationService

protected NotificationService getNotificationService()

setNotificationService

public void setNotificationService(NotificationService notificationService)