org.broadleafcommerce.openadmin.web.controller

Interface AdminAbstractControllerExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractAdminAbstractControllerExtensionHandler

public interface AdminAbstractControllerExtensionHandler
extends ExtensionHandler

Extension handler for methods present in AdminAbstractController.

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NEW_CLASS_NAME

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionResultStatusType	addAdditionalMainActions(String sectionClassName, List<EntityFormAction> actions) Invoked every time AdminBasicEntityController#viewEntityList() is invoked to allow additional main form actions to be contributed.
ExtensionResultStatusType	modifyDynamicForm(EntityForm form, String parentEntityId) Invoked whenever AdminAbstractController.getBlankDynamicFieldTemplateForm(org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo) or AdminAbstractController.getDynamicFieldTemplateForm(org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo, java.lang.String, org.broadleafcommerce.openadmin.web.form.entity.EntityForm) is invoked.
ExtensionResultStatusType	modifyMainActions(ClassMetadata cmd, List<EntityFormAction> mainActions) Extension point to override the actions that are added by default when viewing a ceiling entity for a particular section (for instance, a list of Products in the 'Product' section).
ExtensionResultStatusType	overrideClassNameForSection(ExtensionResultHolder erh, String sectionKey, AdminSection section) Invoked whenever AdminAbstractController.getClassNameForSection(String) is invoked.
ExtensionResultStatusType	setAdditionalModelAttributes(org.springframework.ui.Model model, String sectionKey) Invoked every time AdminAbstractController.setModelAttributes(Model, String) is invoked.

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Field Detail

NEW_CLASS_NAME

static final String NEW_CLASS_NAME

See Also:

Constant Field Values

Method Detail

addAdditionalMainActions

ExtensionResultStatusType addAdditionalMainActions(String sectionClassName,
                                                 List<EntityFormAction> actions)

Invoked every time AdminBasicEntityController#viewEntityList() is invoked to allow additional main form actions to be contributed.

Parameters:

model -

sectionKey -

Returns:

modifyMainActions

ExtensionResultStatusType modifyMainActions(ClassMetadata cmd,
                                          List<EntityFormAction> mainActions)

Extension point to override the actions that are added by default when viewing a ceiling entity for a particular section (for instance, a list of Products in the 'Product' section). Assuming that the user has proper permissions, the mainActions list would have DefaultMainActions.ADD

Parameters:

cmd - the metadata for the ceiling entity that is being displayed

mainActions - the actions that are added to the main form by default. Use this list to add more actions

setAdditionalModelAttributes

ExtensionResultStatusType setAdditionalModelAttributes(org.springframework.ui.Model model,
                                                     String sectionKey)

Invoked every time AdminAbstractController.setModelAttributes(Model, String) is invoked.

Parameters:

model -

sectionKey -

Returns:

the extension result status

overrideClassNameForSection

ExtensionResultStatusType overrideClassNameForSection(ExtensionResultHolder erh,
                                                    String sectionKey,
                                                    AdminSection section)

Invoked whenever AdminAbstractController.getClassNameForSection(String) is invoked. If an extension handler sets the NEW_CLASS_NAME variable in the ExtensionResultHolder, the overriden value will be used.

Parameters:

erh -

sectionKey -

section -

Returns:

modifyDynamicForm

ExtensionResultStatusType modifyDynamicForm(EntityForm form,
                                          String parentEntityId)

Invoked whenever AdminAbstractController.getBlankDynamicFieldTemplateForm(org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo) or AdminAbstractController.getDynamicFieldTemplateForm(org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo, java.lang.String, org.broadleafcommerce.openadmin.web.form.entity.EntityForm) is invoked. This method provides the ability to modify the dynamic form that is created as a result of those two methods.

Parameters:

form -

parentEntityId -

Returns: