org.broadleafcommerce.openadmin.web.service

Interface SearchFieldResolver

All Known Implementing Classes:

SearchFieldResolverImpl

public interface SearchFieldResolver

Resolves which field of an entity should be used for searching when targeting an entity directly and not a specific field on that entity.

Author:

Andre Azzolini (apazzolini)

Method Summary

Modifier and Type	Method and Description
String	resolveField(String className) Returns the name of the field to use for searching for the given entity classname.
default String	resolveField(String className, List<SectionCrumb> sectionCrumbs) Returns the name of the field to use for searching for the given entity classname, inspecting it with the given section crumbs.

Method Detail

resolveField

String resolveField(String className)
             throws ServiceException

Returns the name of the field to use for searching for the given entity classname.

Parameters:

className -

Returns:

the field name

Throws:

ServiceException

resolveField

default String resolveField(String className,
                            List<SectionCrumb> sectionCrumbs)
                     throws ServiceException

Returns the name of the field to use for searching for the given entity classname, inspecting it with the given section crumbs. Use this when the entity is being inspected as the target of a lookup field, so the inspect is authorized the same way as the lookup fetch itself (through the owning entity's crumb) rather than requiring direct permission on the looked-up entity.

Parameters:

className -

sectionCrumbs -

Returns:

the field name

Throws:

ServiceException