de.hybris.platform.omsbackoffice.widgets.customersupportrefineby

Class CustomerSupportRefineByController

java.lang.Object

DefaultWidgetController

de.hybris.platform.omsbackoffice.widgets.customersupportrefineby.CustomerSupportRefineByController

public class CustomerSupportRefineByController
extends DefaultWidgetController

Controller allowing to filter a collection browser based combine with advanced search logic.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT
static java.lang.String	CURRENT_SEARCH
static java.lang.String	CURRENT_SEARCH_SEPARATOR
static java.lang.String	CUSTOMERSUPPORTBACKOFFICE_REFINE_BY
static java.lang.String	GET_NAME
static java.lang.String	GROUP_VALUES_SEPARATOR
static java.lang.String	REFINE_BY_CONTAINER
static java.lang.String	SOCKET_IN_ADVANCED_SEARCH_INIT_CONTEXT
static java.lang.String	SOCKET_IN_NODE_SELECTED
static java.lang.String	SOCKET_OUT_OUTPUT_CONTEXT
static java.lang.String	TYPE_CODE

Constructor Summary

Constructors

Constructor and Description
CustomerSupportRefineByController()

Method Summary

Modifier and Type	Method and Description
protected void	addConditionList(AdvancedSearchData searchData, java.util.Map<java.lang.String,java.util.List<SearchConditionData>> searchExpressions) Adds refine by filters conditions to the existing ones.
protected void	addSearchCondition(Checkbox checkbox, java.util.Map<java.lang.String,java.util.List<SearchConditionData>> searchFieldConditions, AdvancedSearchData advancedSearchData) Adds the search conditions associated to the selected Checkbox
protected FlexibleSearchQuery	buildSearchQuery(java.lang.String typeCode, java.lang.String searchValue) Builds a FlexibleSearchQuery
void	completeAdvancedSearchInitContext(AdvancedSearchInitContext context) Adds refine by filters to the initial given AdvancedSearchInitContext.
protected Div	getCustomerSupportFilterContainer()
protected Label	getEmptyFilters()
protected EnumerationService	getEnumerationService()
protected FlexibleSearchService	getFlexibleSearchService()
protected RefineBy	getRefineByConfig()
protected TypeFacade	getTypeFacade()
void	initialize(Component comp)
protected DataType	loadDataTypeForCode(java.lang.String typeCode) Loads a DataType by its code.
protected RefineBy	loadRefineByConfiguration(java.lang.String typeCode) Loads the configuration of the refine by according to the given type.
void	onNodeSelected(NavigationNode nodeSelected) Resets the refine by widget on NavigationNode selection.
protected void	renderCheckbox(java.lang.String searchFieldName, java.util.ArrayList searchFieldPossibleValues, java.lang.String typeCode, SearchValue searchFieldValue, Div searchFieldDiv) Render a checkbox with her associated hidden Label which contains the search value.
protected void	renderRefineByFromConfig(java.lang.String typeCode) Renders the filters based on customersupportbackoffice-refine-by configuration.
protected void	resetWidget() Resets the content of the filter container.
void	setCustomerSupportFilterContainer(Div customersupportFilterContainer)
void	setEmptyFilters(Label emptyFilters)
void	setEnumerationService(EnumerationService enumerationService)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setRefineByConfig(RefineBy refineByConfig)
void	setTypeFacade(TypeFacade typeFacade)
protected void	submitFilter(Event event) Submits a new search on checkbox selection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOCKET_IN_NODE_SELECTED

public static final java.lang.String SOCKET_IN_NODE_SELECTED

See Also:

Constant Field Values

SOCKET_IN_ADVANCED_SEARCH_INIT_CONTEXT

public static final java.lang.String SOCKET_IN_ADVANCED_SEARCH_INIT_CONTEXT

See Also:

Constant Field Values

SOCKET_OUT_OUTPUT_CONTEXT

public static final java.lang.String SOCKET_OUT_OUTPUT_CONTEXT

See Also:

Constant Field Values

GET_NAME

public static final java.lang.String GET_NAME

See Also:

Constant Field Values

CUSTOMERSUPPORTBACKOFFICE_REFINE_BY

public static final java.lang.String CUSTOMERSUPPORTBACKOFFICE_REFINE_BY

See Also:

Constant Field Values

GROUP_VALUES_SEPARATOR

public static final java.lang.String GROUP_VALUES_SEPARATOR

See Also:

Constant Field Values

REFINE_BY_CONTAINER

public static final java.lang.String REFINE_BY_CONTAINER

See Also:

Constant Field Values

CURRENT_SEARCH

public static final java.lang.String CURRENT_SEARCH

See Also:

Constant Field Values

TYPE_CODE

public static final java.lang.String TYPE_CODE

See Also:

Constant Field Values

CONTEXT

public static final java.lang.String CONTEXT

See Also:

Constant Field Values

CURRENT_SEARCH_SEPARATOR

public static final java.lang.String CURRENT_SEARCH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

CustomerSupportRefineByController

public CustomerSupportRefineByController()

Method Detail

onNodeSelected

public void onNodeSelected(NavigationNode nodeSelected)

Resets the refine by widget on NavigationNode selection.

Parameters:

nodeSelected - the selected NavigationNode

initialize

public void initialize(Component comp)

completeAdvancedSearchInitContext

public void completeAdvancedSearchInitContext(AdvancedSearchInitContext context)

Adds refine by filters to the initial given AdvancedSearchInitContext.

Parameters:

context - the AdvancedSearchInitContext input

addConditionList

protected void addConditionList(AdvancedSearchData searchData,
                                java.util.Map<java.lang.String,java.util.List<SearchConditionData>> searchExpressions)

Adds refine by filters conditions to the existing ones.

Parameters:

searchData - the original {link AdvancedSearchData}

searchExpressions - the search expressions defined in the configuration

addSearchCondition

protected void addSearchCondition(Checkbox checkbox,
                                  java.util.Map<java.lang.String,java.util.List<SearchConditionData>> searchFieldConditions,
                                  AdvancedSearchData advancedSearchData)

Adds the search conditions associated to the selected Checkbox

Parameters:

checkbox - the selected Checkbox

searchFieldConditions - the Map> containing all the search conditions

advancedSearchData - the AdvancedSearchData

buildSearchQuery

protected FlexibleSearchQuery buildSearchQuery(java.lang.String typeCode,
                                               java.lang.String searchValue)

Builds a FlexibleSearchQuery

Parameters:

typeCode - the DataType#code

searchValue - the search value

Returns:

the created FlexibleSearchQuery

loadDataTypeForCode

protected DataType loadDataTypeForCode(java.lang.String typeCode)

Loads a DataType by its code.

Parameters:

typeCode - the DataType#code

Returns:

the DataType retrieved

loadRefineByConfiguration

protected RefineBy loadRefineByConfiguration(java.lang.String typeCode)

Loads the configuration of the refine by according to the given type.

Parameters:

typeCode - the DataType#code

Returns:

the completed RefineBy

renderCheckbox

protected void renderCheckbox(java.lang.String searchFieldName,
                              java.util.ArrayList searchFieldPossibleValues,
                              java.lang.String typeCode,
                              SearchValue searchFieldValue,
                              Div searchFieldDiv)

Render a checkbox with her associated hidden Label which contains the search value.

Parameters:

searchFieldName - the name of the field to search on

searchFieldPossibleValues - the list of search expressions to search

typeCode - the DataType#code

searchFieldValue - the value of the field to search

searchFieldDiv - the Div to which the checkbox will be added

renderRefineByFromConfig

protected void renderRefineByFromConfig(java.lang.String typeCode)

Renders the filters based on customersupportbackoffice-refine-by configuration.

Parameters:

typeCode - the DataType#code

resetWidget

protected void resetWidget()

Resets the content of the filter container.

submitFilter

protected void submitFilter(Event event)

Submits a new search on checkbox selection.

Parameters:

event - the click event on one of the checkboxes

getRefineByConfig

protected RefineBy getRefineByConfig()

setRefineByConfig

public void setRefineByConfig(RefineBy refineByConfig)

getCustomerSupportFilterContainer

protected Div getCustomerSupportFilterContainer()

setCustomerSupportFilterContainer

public void setCustomerSupportFilterContainer(Div customersupportFilterContainer)

getEmptyFilters

protected Label getEmptyFilters()

setEmptyFilters

public void setEmptyFilters(Label emptyFilters)

getTypeFacade

protected TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getFlexibleSearchService

protected FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

getEnumerationService

protected EnumerationService getEnumerationService()

setEnumerationService

public void setEnumerationService(EnumerationService enumerationService)