Package org.broadleafcommerce.admin.web.controller.entity

Class AdminOfferController

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

@Controller("blAdminOfferController")
@RequestMapping("/offer")
public class AdminOfferController
extends AdminBasicEntityController

Handles admin operations for the Offer entity. Certain Offer fields should only render when specific values are set for other fields; we provide the support for that in this controller.

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	customCriteria
protected OfferService	offerService
static final String	SECTION_KEY

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

adminUserDao, adornedTargetAutoPopulateExtensionManager, ALTERNATE_ID_PROPERTY, CURRENT_FOLDER_ID, CUSTOM_CRITERIA, duplicator, dynamicEntityDao, genericEntityService, IS_SELECTIZE_REQUEST, LOG, multipleCatalogExtensionManager, rowLevelSecurityService, sandBoxHelper

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

adminNavigationService, adminRemoteSecurityService, CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME, CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME, customCriteriaService, DEFAULT_CONTAINER_VIEW, entityConfiguration, entityFormValidator, eps, extensionManager, FILTER_VALUE_SEPARATOR, FILTER_VALUE_SEPARATOR_REGEX, filterProductTypeExtensionManager, formService, MODAL_CONTAINER_VIEW, service, validationService

Constructor Summary

Constructors

Constructor	Description
AdminOfferController()

Method Summary

Modifier and Type	Method	Description
String	addEntity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, EntityForm entityForm, org.springframework.validation.BindingResult result)
String	duplicateEntity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, EntityForm entityForm, org.springframework.validation.BindingResult result)	Deprecated. Moved method to superclass
String[]	getSectionCustomCriteria()
protected String	getSectionKey(Map<String,String> pathVars)
protected void	modifyModelAttributes(org.springframework.ui.Model model)	Offer field visibility is dependent on other fields in the entity.
String	viewAddEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String entityType)
String	viewEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id)
String	viewEntityList(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, org.springframework.util.MultiValueMap<String,String> requestParams)

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

addAddActionIfAllowed, addAuditableDisplayField, addAuditableDisplayFields, addCollectionItem, addCollectionItem, addEmptyCollectionItem, addSelectizeCollectionItem, buildAddCollectionItemModel, buildAuditableDisplayField, buildDirtyList, buildSelectizeCustomCriteria, declareShouldIgnoreAdditionStatusFilter, determineEntityType, getCollectionFieldRecords, getCollectionValueDetails, getCurrentFolderId, getCurrentTabName, getCustomCriteria, getErrorDuplicatingResponse, getModalForBlankEntityType, getSelectizeCollectionOptions, getViewSubRecords, initBinder, isAddActionAllowed, isNotReadOnly, modifyEntityForm, reinitializeEntityForm, removeCollectionItem, removeCollectionItem, removeEntity, resolveAppropriateEntityView, saveEntity, saveEntityJson, setTypedEntityModelAttributes, setupViewEntityListBasicModel, showAddCollectionItem, showUpdateCollectionItem, showUpdateCollectionItem, showViewCollectionItem, showViewCollectionItem, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, updateCollectionItem, updateCollectionItem, updateCollectionItemSequence, updateCollectionItemSequence, viewCollectionItemDetails, viewCollectionItemTab, viewEntityListSelectize, viewEntityTab, viewReadOnlyCollectionItemTab

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

attachSectionSpecificInfo, attachSectionSpecificInfo, createSectionCrumb, declareForceUseAdditionStatusFilter, extractDynamicFormFields, getAddEntityTypes, getClassNameForSection, getCollectionListGrid, getCollectionListGrid, getCriteria, getDefaultEntityType, getDynamicFieldTemplateForm, getDynamicForm, getEntityForm, getEntityForm, getEntityForm, getFirstId, getLastId, getLowerCount, getMaxIndex, getMaxResults, getPageSize, getPersistencePackageRequest, getSectionCrumbs, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSortDirections, getSortPropertyNames, getStartIndex, getUpperCount, modifyAddEntityForm, modifyCriteria, modifyEntityForm, populateJsonValidationErrors, setModelAttributes, setSpecializedNameForFields, translateErrorMessage

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 Details

SECTION_KEY

public static final String SECTION_KEY

See Also:

• Constant Field Values

customCriteria

public static String[] customCriteria

offerService

protected OfferService offerService

Constructor Details

AdminOfferController

public AdminOfferController()

Method Details

getSectionKey

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

Overrides:

getSectionKey in class AdminAbstractController

getSectionCustomCriteria

public String[] getSectionCustomCriteria()

Overrides:

getSectionCustomCriteria in class AdminAbstractController

viewEntityList

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

Overrides:

viewEntityList in class AdminBasicEntityController

Throws:

Exception

viewEntityForm

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

Overrides:

viewEntityForm in class AdminBasicEntityController

Throws:

Exception

viewAddEntityForm

@RequestMapping(value="/add",
                method=GET)
public String viewAddEntityForm(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 @PathVariable
 Map<String,String> pathVars,
 @RequestParam(defaultValue="")
 String entityType)
                         throws Exception

Overrides:

viewAddEntityForm in class AdminBasicEntityController

Throws:

Exception

addEntity

@RequestMapping(value="/add",
                method=POST)
public String addEntity(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 @PathVariable
 Map<String,String> pathVars,
 @ModelAttribute("entityForm")
 EntityForm entityForm,
 org.springframework.validation.BindingResult result)
                 throws Exception

Overrides:

addEntity in class AdminBasicEntityController

Throws:

Exception

duplicateEntity

@Deprecated
@RequestMapping(value="/{id}/duplicate",
                method=POST)
public String duplicateEntity(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 @PathVariable
 Map<String,String> pathVars,
 @PathVariable("id")
 String id,
 @ModelAttribute("entityForm")
 EntityForm entityForm,
 org.springframework.validation.BindingResult result)
                       throws Exception

Deprecated.

Moved method to superclass

Overrides:

duplicateEntity in class AdminBasicEntityController

Throws:

Exception

modifyModelAttributes

protected void modifyModelAttributes(org.springframework.ui.Model model)

Offer field visibility is dependent on other fields in the entity. Mark the form with the appropriate class so that the Javascript will know to handle this form.

We also want to tell the UI to make item target criteria required. We cannot manage this at the entity level via an