org.broadleafcommerce.admin.web.controller.entity

Class AdminProductController

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.AdminProductController

@Controller(value="blAdminProductController")
@RequestMapping(value="/product")
public class AdminProductController
extends AdminBasicEntityController

Handles admin operations for the Product entity. Editing a product requires custom criteria in order to properly invoke the ProductCustomPersistenceHandler

Author:

Andre Azzolini (apazzolini)

See Also:

ProductCustomPersistenceHandler}

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
AdminProductController()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildAddCollectionItemModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, String id, String collectionField, String sectionKey, Property collectionProperty, FieldMetadata md, PersistencePackageRequest ppr, EntityForm entityForm, Entity entity) Builds out all of the model information needed for showing the add modal for collection items on both the initial GET as well as after a POST with validation errors
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 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.
protected String	showAddAdditionalSku(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, String id, Map<String,String> pathVars)
String	showAddCollectionItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, org.springframework.util.MultiValueMap<String,String> requestParams) Shows the modal dialog that is used to add an item to a given collection.
protected String	showUpdateAdditionalSku(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model model, String id, String collectionItemId, Map<String,String> pathVars, EntityForm entityForm)
String	showUpdateCollectionItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String collectionItemId)
protected String	showViewUpdateCollection(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String collectionItemId, String alternateId, String modalHeaderType, EntityForm entityForm, Entity entity) Shows the view and populates the model for updating a collection item.
String	viewEntityForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id) Renders the main entity form for the specified entity

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

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

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

AdminProductController

public AdminProductController()

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

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

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

showAddAdditionalSku

protected String showAddAdditionalSku(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          org.springframework.ui.Model model,
                          String id,
                          Map<String,String> pathVars)
                               throws Exception

Throws:

Exception

buildAddCollectionItemModel

protected String buildAddCollectionItemModel(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 org.springframework.ui.Model model,
                                 String id,
                                 String collectionField,
                                 String sectionKey,
                                 Property collectionProperty,
                                 FieldMetadata md,
                                 PersistencePackageRequest ppr,
                                 EntityForm entityForm,
                                 Entity entity)
                                      throws ServiceException

Description copied from class: AdminBasicEntityController

Builds out all of the model information needed for showing the add modal for collection items on both the initial GET as well as after a POST with validation errors

Overrides:

buildAddCollectionItemModel in class AdminBasicEntityController

Returns:

the appropriate view to display for the modal

Throws:

ServiceException

See Also:

#addCollectionItem(HttpServletRequest, HttpServletResponse, Model, Map, String, String, EntityForm, BindingResult)}, #showAddCollectionItem(HttpServletRequest, HttpServletResponse, Model, Map, String, String, MultiValueMap)}

showUpdateAdditionalSku

protected String showUpdateAdditionalSku(javax.servlet.http.HttpServletRequest request,
                             org.springframework.ui.Model model,
                             String id,
                             String collectionItemId,
                             Map<String,String> pathVars,
                             EntityForm entityForm)
                                  throws Exception

Throws:

Exception

showUpdateCollectionItem

@RequestMapping(value="/{id}/{collectionField:.*}/{collectionItemId}",
                method=GET)
public String showUpdateCollectionItem(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response,
                                             org.springframework.ui.Model model,
                                             @PathVariable
                                             Map<String,String> pathVars,
                                             @PathVariable(value="id")
                                             String id,
                                             @PathVariable(value="collectionField")
                                             String collectionField,
                                             @PathVariable(value="collectionItemId")
                                             String collectionItemId)
                                throws Exception

Overrides:

showUpdateCollectionItem in class AdminBasicEntityController

Throws:

Exception

showViewUpdateCollection

protected String showViewUpdateCollection(javax.servlet.http.HttpServletRequest request,
                              org.springframework.ui.Model model,
                              Map<String,String> pathVars,
                              String id,
                              String collectionField,
                              String collectionItemId,
                              String alternateId,
                              String modalHeaderType,
                              EntityForm entityForm,
                              Entity entity)
                                   throws ServiceException

Description copied from class: AdminBasicEntityController

Shows the view and populates the model for updating a collection item. You can also pass in an entityform and entity which are optional. If they are not passed in then they are automatically looked up

Overrides:

showViewUpdateCollection in class AdminBasicEntityController

Returns:

Throws:

ServiceException

showAddCollectionItem

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

Description copied from class: AdminBasicEntityController

Shows the modal dialog that is used to add an item to a given collection. There are several possible outcomes of this call depending on the type of the specified collection field.

• Basic Collection (Persist) - Renders a blank form for the specified target entity so that the user may enter information and associate the record with this collection. Used by fields such as ProductAttribute.
• Basic Collection (Lookup) - Renders a list grid that allows the user to click on an entity and select it. Used by fields such as "allParentCategories".
• Adorned Collection (without form) - Renders a list grid that allows the user to click on an entity and select it. The view rendered by this is identical to basic collection (lookup), but will perform the operation on an adorned field, which may carry extra meta-information about the created relationship, such as order.
• Adorned Collection (with form) - Renders a list grid that allows the user to click on an entity and select it. Once the user selects the entity, he will be presented with an empty form based on the specified "maintainedAdornedTargetFields" for this field. Used by fields such as "crossSellProducts", which in addition to linking an entity, provide extra fields, such as a promotional message.
• Map Collection - Renders a form for the target entity that has an additional key field. This field is populated either from the configured map keys, or as a result of a lookup in the case of a key based on another entity. Used by fields such as the mediaMap on a Sku.

Overrides:

showAddCollectionItem in class AdminBasicEntityController

Returns:

the return view path

Throws:

Exception

viewEntityForm

@RequestMapping(value="/{id}",
                method=GET)
public String viewEntityForm(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   org.springframework.ui.Model model,
                                   @PathVariable
                                   Map<String,String> pathVars,
                                   @PathVariable(value="id")
                                   String id)
                      throws Exception

Description copied from class: AdminBasicEntityController

Renders the main entity form for the specified entity

Overrides:

viewEntityForm in class AdminBasicEntityController

Returns:

the return view path

Throws:

Exception