com.broadleafcommerce.enterprise.workflow.admin.web.controller

Class AdminEntityStatusController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

com.broadleafcommerce.enterprise.workflow.admin.web.controller.AdminEntityStatusController

Direct Known Subclasses:

AdminCompoundSectionEntityStatusController, AdminInventoryEntityStatusController

@Controller(value="blAdminEntityStatusController")
 @RequestMapping(value="/status/{sectionKey:.+}")
public class AdminEntityStatusController
extends org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

API for retrieving current change status information for one or more sandboxable entities. Changes to entities usually occur in the enterprise admin and can be in various states (e.g. LOCAL, PENDING, ADD). These states represent the current user sandbox, the approval sandbox, or an addition in the current user sandbox, respectively.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOG
protected ModuleManager	moduleManager
protected org.broadleafcommerce.openadmin.server.factory.PersistencePackageFactory	persistencePackageFactory
protected SandBoxHelperImpl	sandBoxHelper
protected SimpleChangeDetailDao	simpleChangeDetailDao
protected SimpleStatusDao	simpleStatusDao

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, extensionManager, FILTER_VALUE_SEPARATOR, FILTER_VALUE_SEPARATOR_REGEX, filterProductTypeExtensionManager, formService, MODAL_CONTAINER_VIEW, service, validationService

Constructor Summary

Constructors

Constructor and Description
AdminEntityStatusController()

Method Summary

Modifier and Type	Method and Description
EntityStatus	getEntityStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, Boolean includeProperties) Get the status for a specific entity.
Set<EntityStatus>	getEntityStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String[] ids, Boolean includeProperties, org.springframework.util.MultiValueMap<String,String> requestParams) Get the statuses for one or more entities that are members of a collection field.
EntityStatus	getEntityStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String memberId, Boolean includeProperties, org.springframework.util.MultiValueMap<String,String> requestParams) Get the status for a specific entity that is a member of a collection field.
Set<EntityStatus>	getEntityStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String operation, String[] ids, Boolean includeProperties, org.springframework.util.MultiValueMap<String,String> requestParams) Get the statuses for one or more entities that are members of a collection field used as a lookup.
EntityStatus	getEntityStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String memberId, String alternateId, Boolean includeProperties, org.springframework.util.MultiValueMap<String,String> requestParams) Get the status for a specific entity that is a member of a collection field.
Set<EntityStatus>	getEntityStatuses(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String[] ids, Boolean includeProperties) Get the statuses for one or more entities based on the list of ids.
protected boolean	isSandBoxable(String sectionClassName)

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

attachSectionSpecificInfo, attachSectionSpecificInfo, createSectionCrumb, extractDynamicFormFields, getAddEntityTypes, getClassNameForSection, getCollectionListGrid, getCollectionListGrid, getCriteria, getDefaultEntityType, getDynamicFieldTemplateForm, getDynamicForm, getEntityForm, getEntityForm, getEntityForm, getFirstId, getLastId, getLowerCount, getMaxIndex, getMaxResults, getPageSize, getPersistencePackageRequest, getSectionCrumbs, getSectionCustomCriteria, getSectionKey, 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 Detail

LOG

protected static final org.apache.commons.logging.Log LOG

moduleManager

protected ModuleManager moduleManager

persistencePackageFactory

protected org.broadleafcommerce.openadmin.server.factory.PersistencePackageFactory persistencePackageFactory

sandBoxHelper

protected SandBoxHelperImpl sandBoxHelper

simpleStatusDao

protected SimpleStatusDao simpleStatusDao

simpleChangeDetailDao

protected SimpleChangeDetailDao simpleChangeDetailDao

Constructor Detail

AdminEntityStatusController

public AdminEntityStatusController()

Method Detail

getEntityStatuses

@RequestMapping(value="",
                method=GET,
                params={"ids","includeProperties"})
 @ResponseBody
public Set<EntityStatus> getEntityStatuses(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                    javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                    org.springframework.ui.Model model,
                                                                                                                                                                    @PathVariable
                                                                                                                                                                    Map<String,String> pathVars,
                                                                                                                                                                    @RequestParam(value="ids",required=true)
                                                                                                                                                                    String[] ids,
                                                                                                                                                                    @RequestParam(value="includeProperties",defaultValue="true")
                                                                                                                                                                    Boolean includeProperties)
                                                                                                                                                             throws Exception

Get the statuses for one or more entities based on the list of ids. Will only return a status for an entity that is considered to be dirty (i.e. one or more properties have been edited in the entity).

Parameters:

request -

response -

model -

pathVars -

ids - the required list of ids to check

includeProperties - whether or not to include the status of each of the dirty properties in the respective entities

Returns:

Throws:

Exception

getEntityStatus

@RequestMapping(value="/{id:\\-?[0-9]+}",
                method=GET)
 @ResponseBody
public EntityStatus getEntityStatus(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,
                                                                                                                         @RequestParam(value="includeProperties",defaultValue="true")
                                                                                                                         Boolean includeProperties)
                                                                                                                  throws Exception

Get the status for a specific entity. Will only return a status for an entity that is considered to be dirty (i.e. one or more properties have been edited in the entity).

Parameters:

request -

response -

model -

pathVars -

id - the entity id

includeProperties - whether or not to include the status of each of the dirty properties in the respective entities

Returns:

Throws:

Exception

getEntityStatus

@RequestMapping(value="/{id:\\-?[0-9]+}/{collectionField:.*}",
                method=GET)
 @ResponseBody
public Set<EntityStatus> getEntityStatus(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(value="ids",required=true)
                                                                                                                                                   String[] ids,
                                                                                                                                                   @RequestParam(value="includeProperties",defaultValue="true")
                                                                                                                                                   Boolean includeProperties,
                                                                                                                                                   @RequestParam
                                                                                                                                                   org.springframework.util.MultiValueMap<String,String> requestParams)
                                                                                                                                            throws Exception

Get the statuses for one or more entities that are members of a collection field. Will only return a status for an entity that is considered to be dirty (i.e. one or more properties have been edited in the entity).

Parameters:

request -

response -

model -

pathVars -

id - the id of the entity that contains the collection field

collectionField - the name of the collection field

ids - the required list of collection member ids to check

includeProperties - whether or not to include the status of each of the dirty properties in the respective entities

requestParams -

Returns:

Throws:

Exception

getEntityStatus

@RequestMapping(value="/{id:\\-?[0-9]+}/{collectionField:.*}/{operation:[A-Za-z]+}",
                method=GET)
 @ResponseBody
public Set<EntityStatus> getEntityStatus(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="operation")
                                                                                                                                                                         String operation,
                                                                                                                                                                         @RequestParam(value="ids",required=true)
                                                                                                                                                                         String[] ids,
                                                                                                                                                                         @RequestParam(value="includeProperties",defaultValue="true")
                                                                                                                                                                         Boolean includeProperties,
                                                                                                                                                                         @RequestParam
                                                                                                                                                                         org.springframework.util.MultiValueMap<String,String> requestParams)
                                                                                                                                                                  throws Exception

Get the statuses for one or more entities that are members of a collection field used as a lookup. Will only return a status for an entity that is considered to be dirty (i.e. one or more properties have been edited in the entity).

Parameters:

request -

response -

model -

pathVars -

id -

collectionField -

operation -

ids -

includeProperties -

requestParams -

Returns:

Throws:

Exception

getEntityStatus

@RequestMapping(value="/{id:\\-?[0-9]+}/{collectionField:.*}/{memberId:\\-?[0-9]+}",
                method=GET)
 @ResponseBody
public EntityStatus getEntityStatus(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="memberId")
                                                                                                                                                                    String memberId,
                                                                                                                                                                    @RequestParam(value="includeProperties",defaultValue="true")
                                                                                                                                                                    Boolean includeProperties,
                                                                                                                                                                    @RequestParam
                                                                                                                                                                    org.springframework.util.MultiValueMap<String,String> requestParams)
                                                                                                                                                             throws Exception

Get the status for a specific entity that is a member of a collection field. Will only return a status for an entity that is considered to be dirty (i.e. one or more properties have been edited in the entity).

Parameters:

request -

response -

model -

pathVars -

id - the id of the entity that contains the collection field

collectionField - the name of the collection field

memberId - the collection member id to check

includeProperties - whether or not to include the status of each of the dirty properties in the respective entities

requestParams -

Returns:

Throws:

Exception

getEntityStatus

@RequestMapping(value="/{id:\\-?[0-9]+}/{collectionField:.*}/{memberId:\\-?[0-9]+}/{alternateId:\\-?[0-9]+}",
                method=GET)
 @ResponseBody
public EntityStatus getEntityStatus(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="memberId")
                                                                                                                                                                                             String memberId,
                                                                                                                                                                                             @PathVariable(value="alternateId")
                                                                                                                                                                                             String alternateId,
                                                                                                                                                                                             @RequestParam(value="includeProperties",defaultValue="true")
                                                                                                                                                                                             Boolean includeProperties,
                                                                                                                                                                                             @RequestParam
                                                                                                                                                                                             org.springframework.util.MultiValueMap<String,String> requestParams)
                                                                                                                                                                                      throws Exception

Get the status for a specific entity that is a member of a collection field. Will only return a status for an entity that is considered to be dirty (i.e. one or more properties have been edited in the entity). This endpoint contains the additional "alternateId" param that holds an aka id for the collection member. This alternate id is primarily useful when checking adorned target collection members (AdminPresentationAdornedTargetCollection).

Parameters:

request -

response -

model -

pathVars -

id - the id of the entity that contains the collection field

collectionField - the name of the collection field

memberId - the collection member id to check

alternateId - an "aka" id for the collection member - used when identifying an adorned target collection member

includeProperties - whether or not to include the status of each of the dirty properties in the respective entities

requestParams -

Returns:

Throws:

Exception

isSandBoxable

protected boolean isSandBoxable(String sectionClassName)