org.broadleafcommerce.admin.web.controller.entity

Class AdminCategoryController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

org.broadleafcommerce.admin.web.controller.entity.AdminCategoryController

@Controller(value="blAdminCategoryController")
@RequestMapping(value="/category")
public class AdminCategoryController
extends AdminBasicEntityController

Handles admin operations for the Category entity.

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
protected CatalogService	catalogService
protected static String	SECTION_KEY

Fields inherited from class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

hideTopLevelErrors, LOG, sandBoxHelper

Fields inherited from class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

adminNavigationService, adminRemoteSecurityService, CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME, CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME, entityConfiguration, entityFormValidator, extensionManager, FILTER_VALUE_SEPARATOR, FILTER_VALUE_SEPARATOR_REGEX, formService, mainEntityActionsExtensionManager, service

Constructor Summary

Constructors

Constructor and Description
AdminCategoryController()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	entityListWithTreeView(org.springframework.ui.Model model)
String[]	getSectionCustomCriteria() This method is invoked for every request for this controller.
protected String	getSectionKey(Map<String,String> pathVars) This method is used to determine the current section key.
protected boolean	getTreeViewEnabled()
protected void	modifyAddEntityForm(EntityForm ef, Map<String,String> pathVars) This method is invoked whenever an assembled EntityForm is rendered for the add entity screen.
protected void	modifyEntityForm(EntityForm ef, Map<String,String> pathVars) This method is invoked whenever an assembled EntityForm is rendered.
String	viewEntityList(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, org.springframework.util.MultiValueMap<String,String> requestParams) Renders the main entity listing for the specified class, which is based on the current sectionKey with some optional criteria.

Methods inherited from class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

addAddActionIfAllowed, addCollectionItem, addEntity, buildAddCollectionItemModel, buildDirtyList, getCollectionFieldRecords, getCollectionValueDetails, initBinder, isAddActionAllowed, populateJsonValidationErrors, removeCollectionItem, removeCollectionItem, removeEntity, saveEntity, saveEntityJson, showAddCollectionItem, showUpdateCollectionItem, showUpdateCollectionItem, showViewCollectionItem, showViewCollectionItem, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, translateErrorMessage, updateCollectionItem, updateCollectionItem, updateCollectionItemSequence, updateCollectionItemSequence, viewAddEntityForm, viewCollectionItemDetails, viewEntityForm

Methods inherited from class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

attachSectionSpecificInfo, attachSectionSpecificInfo, extractDynamicFormFields, getAddEntityTypes, getBlankDynamicFieldTemplateForm, getBlankDynamicFieldTemplateForm, getBlankDynamicMasterFieldGroupTemplateForm, getBlankDynamicMasterFieldGroupTemplateForm, getClassNameForSection, getCollectionListGrid, getCollectionListGrid, getCriteria, getDefaultEntityType, getDynamicFieldTemplateForm, getDynamicForm, getEntityForm, getEntityForm, getMaxIndex, getSectionCrumbs, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSortDirections, getSortPropertyNames, getStartIndex, setModelAttributes

Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

addDeepLink, getContextPath, isAjaxRequest, jsonResponse

Methods inherited from class java.lang.Object

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

Field Detail

SECTION_KEY

protected static final String SECTION_KEY

See Also:

Constant Field Values

catalogService

protected CatalogService catalogService

Constructor Detail

AdminCategoryController

public AdminCategoryController()

Method Detail

getSectionKey

protected String getSectionKey(Map<String,String> pathVars)

Description copied from class: AdminAbstractController

This method is used to determine the current section key. For this default implementation, the sectionKey is pulled from the pathVariable, {sectionKey}, as defined by the request mapping on this controller. To support controller inheritance and allow more specialized controllers to delegate some methods to this basic controller, overridden implementations of this method could return a hardcoded value instead of reading the map

Overrides:

getSectionKey in class AdminAbstractController

Parameters:

pathVars - - the map of all currently bound path variables for this request

Returns:

the sectionKey for this request

getTreeViewEnabled

protected boolean getTreeViewEnabled()

modifyEntityForm

protected void modifyEntityForm(EntityForm ef,
                    Map<String,String> pathVars)

Description copied from class: AdminAbstractController

This method is invoked whenever an assembled EntityForm is rendered. This typically occurs when viewing an entity in the admin or viewing an error state on a POST for that entity.

Overrides:

modifyEntityForm in class AdminAbstractController

modifyAddEntityForm

protected void modifyAddEntityForm(EntityForm ef,
                       Map<String,String> pathVars)

Description copied from class: AdminAbstractController

This method is invoked whenever an assembled EntityForm is rendered for the add entity screen.

Overrides:

modifyAddEntityForm in class AdminAbstractController

viewEntityList

@RequestMapping(value="",
                method=GET)
public String viewEntityList(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   org.springframework.ui.Model model,
                                   @PathVariable
                                   Map<String,String> pathVars,
                                   @RequestParam
                                   org.springframework.util.MultiValueMap<String,String> requestParams)
                      throws Exception

Description copied from class: AdminBasicEntityController

Renders the main entity listing for the specified class, which is based on the current sectionKey with some optional criteria.

Overrides:

viewEntityList in class AdminBasicEntityController

requestParams - a Map of property name -> list critiera values

Returns:

the return view path

Throws:

Exception

entityListWithTreeView

protected String entityListWithTreeView(org.springframework.ui.Model model)

getSectionCustomCriteria

public String[] getSectionCustomCriteria()

Description copied from class: AdminAbstractController

This method is invoked for every request for this controller. By default, we do not want to specify a custom criteria, but specialized controllers may want to.

Overrides:

getSectionCustomCriteria in class AdminAbstractController

Returns:

the custom criteria for this section for all requests, if any