com.hybris.cockpitng.widgets.baseeditorarea

Interface EditorAreaLogicHandler

All Known Implementing Classes:

DefaultEditorAreaLogicHandler

public interface EditorAreaLogicHandler

An interface that defines contract for performing the custom logic within DefaultEditorAreaController.

Method Summary

Modifier and Type	Method and Description
void	beforeEditorAreaRender(WidgetInstanceManager widgetInstanceManager, Object currentObject) This method is triggered before editor area content is rendered for given current object DefaultEditorAreaController.
default void	executeSaveWithConfirmation(WidgetInstanceManager widgetInstanceManager, Executable save, Object currentObject) This method allows to hook in and trigger confirmation before save is executed.
Object	performRefresh(WidgetInstanceManager widgetInstanceManager, Object currentObject) This method is responsible for refreshing/reloading current object within DefaultEditorAreaController.
Object	performSave(WidgetInstanceManager widgetInstanceManager, Object currentObject) This method is responsible for saving/persisting current object within DefaultEditorAreaController.
List<ValidationInfo>	performValidation(WidgetInstanceManager widgetInstanceManager, Object currentObject, List<String> qualifiers, ValidationContext validationContext) This method is responsible for validating current object for given qualifiers within DefaultEditorAreaController.
List<ValidationInfo>	performValidation(WidgetInstanceManager widgetInstanceManager, Object currentObject, ValidationContext validationContext) This method is responsible for validating current object within DefaultEditorAreaController.

Method Detail

performSave

Object performSave(WidgetInstanceManager widgetInstanceManager,
                   Object currentObject)
            throws ObjectSavingException

This method is responsible for saving/persisting current object within DefaultEditorAreaController.

Parameters:

widgetInstanceManager - given widgetInstanceManager

currentObject - object that needs to be saved

Returns:

saved object

Throws:

ObjectSavingException

executeSaveWithConfirmation

default void executeSaveWithConfirmation(WidgetInstanceManager widgetInstanceManager,
                                         Executable save,
                                         Object currentObject)

This method allows to hook in and trigger confirmation before save is executed.

Parameters:

widgetInstanceManager - widgetInstanceManager

save - action to be executed if confirmation passes. It has to be executed in method impl.

currentObject - object that needs to be saved

performRefresh

Object performRefresh(WidgetInstanceManager widgetInstanceManager,
                      Object currentObject)
               throws ObjectNotFoundException

This method is responsible for refreshing/reloading current object within DefaultEditorAreaController.

Parameters:

widgetInstanceManager - given widgetInstanceManager

currentObject - object that needs to be refreshed/reload

Returns:

refreshed/reload object

Throws:

ObjectNotFoundException

performValidation

List<ValidationInfo> performValidation(WidgetInstanceManager widgetInstanceManager,
                                       Object currentObject,
                                       ValidationContext validationContext)

This method is responsible for validating current object within DefaultEditorAreaController.

Parameters:

widgetInstanceManager - given widgetInstanceManager

currentObject - object that needs to be validated

validationContext - validation context

Returns:

refreshed/reload object

performValidation

List<ValidationInfo> performValidation(WidgetInstanceManager widgetInstanceManager,
                                       Object currentObject,
                                       List<String> qualifiers,
                                       ValidationContext validationContext)

This method is responsible for validating current object for given qualifiers within DefaultEditorAreaController.

Parameters:

widgetInstanceManager - given widgetInstanceManager

currentObject - object that needs to be validated

qualifiers - qualifiers that needs to be validated

validationContext - validation context

Returns:

refreshed/reload object

beforeEditorAreaRender

void beforeEditorAreaRender(WidgetInstanceManager widgetInstanceManager,
                            Object currentObject)

This method is triggered before editor area content is rendered for given current object DefaultEditorAreaController.

Parameters:

widgetInstanceManager - given widgetInstanceManager

currentObject - object for which editor area is rendered