Package org.broadleafcommerce.openadmin.web.service

Interface ListGridErrorMessageExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

public interface ListGridErrorMessageExtensionHandler
extends org.broadleafcommerce.common.extension.ExtensionHandler

An extension handler to allow a custom error key or error message to be added to the ListGridRecord.

Author:

kellytisdell

Method Summary

Modifier and Type	Method	Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	determineErrorMessageForEntity(Entity entity, ListGridRecord lgr)	Allows the extension handler to determine a custom error message or error message key for the entity.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	determineStatusMessageForEntity(Entity entity, ListGridRecord lgr)	Allows the extension handler to determine a custom status message for the entity.

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

getPriority, isEnabled

Method Details

determineErrorMessageForEntity

org.broadleafcommerce.common.extension.ExtensionResultStatusType determineErrorMessageForEntity(Entity entity,
 ListGridRecord lgr)

Allows the extension handler to determine a custom error message or error message key for the entity. Implementors should determine if they can handle the entity in question. If not, they should return ExtensionResultStatusType.NOT_HANDLED.

Otherwise, they should either set the error message or the error key on the ListGrid on the entity. If both are set the error message will win.

Implementors can use the BroadleafRequestContext to try to determine Locale, or get a MessageSource, etc.

Parameters:

entity -

lgr -

Returns:

determineStatusMessageForEntity

org.broadleafcommerce.common.extension.ExtensionResultStatusType determineStatusMessageForEntity(Entity entity,
 ListGridRecord lgr)

Allows the extension handler to determine a custom status message for the entity.

Parameters:

entity -

lgr -

Returns: