Class DefaultAdvancedSearchModel
java.lang.Object
de.hybris.platform.cockpit.model.advancedsearch.impl.AbstractAdvancedSearchModel
de.hybris.platform.cockpit.model.advancedsearch.impl.DefaultAdvancedSearchModel
- All Implemented Interfaces:
AdvancedSearchModel
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultAdvancedSearchModel(AdvancedSearchConfiguration config, String configCode) DefaultAdvancedSearchModel(AdvancedSearchConfiguration config, String configCode, AdvancedSearchParameterContainer parameterContainer) -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddSortableProperty(PropertyDescriptor sortProp) getEditor(SearchField searchField) Returns theeditorfor a specificsearch field.protected EditorFactorygetEditorMode(SearchField searchField, PropertyDescriptor propDescr) Returns all the available hidden search fields.getParametersForSearchField(SearchField searchField) getPropertyDescriptor(SearchField field) Returns the rootsearch field group.protected SearchTypegetRootSearchType(PropertyDescriptor propDescr) getSearchField(PropertyDescriptor descriptor) Returns all the available search fields.Returns the currently selected type i.e.Returns all the properties which can currently be used for sorting.Returns the property by which search result should be sorted.getTypes()Returns all the types supported by this advanced search.protected TypeServiceReturns all the available visible search fields.protected booleanhideFieldDirectly(SearchField field) protected booleanbooleanhideSearchField(SearchField field) booleanbooleanbooleanbooleanbooleanReturns whether search result is sorted ascending or not.booleanremoveSortableProperty(PropertyDescriptor sortProp) voidMethod cleans search fields and sets type as rootTypevoidsetExcludeRootType(boolean excludeRootType) voidsetIncludeSubTypes(boolean includeSubTypes) voidsetIncludeSubTypesForRelatedTypes(boolean includeSubTypesForRelatedTypes) voidsetParameterContainer(AdvancedSearchParameterContainer paramContainer) voidvoidsetSortableProperties(List<PropertyDescriptor> sortProps) voidsetSortAscending(boolean asc) voidsetSortCriterion(PropertyDescriptor sortProperty, boolean asc) voidsetSortedByProperty(PropertyDescriptor sortProperty) voidsetTypes(Collection<ObjectTemplate> types) voidvoidsetVisibleSearchFields(List<SearchField> searchFields) protected booleanshowFieldDirectly(SearchField field) protected booleanbooleanshowSearchField(SearchField field) booleanprotected voidMethods inherited from class de.hybris.platform.cockpit.model.advancedsearch.impl.AbstractAdvancedSearchModel
addAdvancedSearchModelListener, fireChanged, fireSearchFieldChanged, fireSearchFieldGroupVisibilityChanged, fireSearchFieldVisibilityChanged, fireSelectedTypeChanged, fireSortSearchFieldsChanged, fireTypesChanged, removeAdvancedSearchModelListener
-
Constructor Details
-
DefaultAdvancedSearchModel
-
DefaultAdvancedSearchModel
public DefaultAdvancedSearchModel(AdvancedSearchConfiguration config, String configCode, AdvancedSearchParameterContainer parameterContainer)
-
-
Method Details
-
resetToInitialSearchParameters
public void resetToInitialSearchParameters()Method cleans search fields and sets type as rootType -
setSelectedType
-
setTypes
-
setParameterContainer
-
getParameterContainer
-
setVisibleSearchFieldGroups
-
hideSearchFieldGroup
-
hideGroupDirectly
-
showSearchFieldGroup
-
setVisibleSearchFields
-
hideSearchField
-
hideFieldDirectly
-
showSearchField
-
setSortableProperties
-
addSortableProperty
-
removeSortableProperty
-
setSortCriterion
-
setSortedByProperty
-
setSortAscending
public void setSortAscending(boolean asc) -
getEditor
Description copied from interface:AdvancedSearchModelReturns theeditorfor a specificsearch field.- Parameters:
searchField- the search field, for which the corresponding editor is to be returned- Returns:
- the editor corresponding to the specified search field
-
getEditorMode
-
getParametersForSearchField
- Returns:
- parameters for search field
-
getHiddenSearchFields
Description copied from interface:AdvancedSearchModelReturns all the available hidden search fields.- Returns:
- all the available search fields which are currently hidden
- See Also:
-
getRootSearchFieldGroup
Description copied from interface:AdvancedSearchModelReturns the rootsearch field group.- Returns:
- the root group containing
search fieldsand other groups in a hierarchical structure.
-
getSearchFields
Description copied from interface:AdvancedSearchModelReturns all the available search fields.- Returns:
- all the available search fields
- See Also:
-
getSelectedType
Description copied from interface:AdvancedSearchModelReturns the currently selected type i.e. the type of the items which are being searched for.- Returns:
- the active type
-
getSortableProperties
Description copied from interface:AdvancedSearchModelReturns all the properties which can currently be used for sorting.- Returns:
- all the available properties which can be used for sorting
-
getTypes
Description copied from interface:AdvancedSearchModelReturns all the types supported by this advanced search.- Returns:
- list containing all the available search types
-
getVisibleSearchFields
Description copied from interface:AdvancedSearchModelReturns all the available visible search fields.- Returns:
- all the available search fields which are currently visible
- See Also:
-
getSortedByProperty
Description copied from interface:AdvancedSearchModelReturns the property by which search result should be sorted.- Returns:
- the property to be used for sorting
-
isSortAscending
public boolean isSortAscending()Description copied from interface:AdvancedSearchModelReturns whether search result is sorted ascending or not.- Returns:
trueif ascending,falseif descending
-
getPropertyDescriptor
-
getSearchField
-
showGroupDirectly
-
showFieldDirectly
-
getRootSearchType
-
setExcludeRootType
public void setExcludeRootType(boolean excludeRootType) -
isExcludeRootType
public boolean isExcludeRootType() -
setIncludeSubTypes
public void setIncludeSubTypes(boolean includeSubTypes) -
isIncludeSubTypes
public boolean isIncludeSubTypes() -
setIncludeSubTypesForRelatedTypes
public void setIncludeSubTypesForRelatedTypes(boolean includeSubTypesForRelatedTypes) -
isIncludeSubTypesForRelatedTypes
public boolean isIncludeSubTypesForRelatedTypes() -
storeAdvancedSearchConfiguration
protected void storeAdvancedSearchConfiguration() -
getTypeService
-
getEditorFactory
-