Class PropertySearchFieldConfiguration
- java.lang.Object
-
- de.hybris.platform.cockpit.services.config.impl.PropertySearchFieldConfiguration
-
- All Implemented Interfaces:
SearchFieldConfiguration
public class PropertySearchFieldConfiguration extends java.lang.Object implements SearchFieldConfiguration
Property search field configuration.- See Also:
SearchFieldConfiguration
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface de.hybris.platform.cockpit.services.config.SearchFieldConfiguration
SearchFieldConfiguration.EntryListMode
-
-
Field Summary
-
Fields inherited from interface de.hybris.platform.cockpit.services.config.SearchFieldConfiguration
CONDITION_ENTRIES, ENTRY_LIST_MODE
-
-
Constructor Summary
Constructors Constructor Description PropertySearchFieldConfiguration(PropertyDescriptor propertyDescriptor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<EditorConditionEntry>getConditionEntries()java.lang.StringgetEditor()SearchFieldConfiguration.EntryListModegetEntryListMode()java.lang.StringgetName()Returns the name set for this search field configuration.java.util.Map<java.lang.String,java.lang.String>getParameters()PropertyDescriptorgetPropertyDescriptor()Returns this field's property descriptor.DefaultSearchFieldgetSearchField()Returns thesearch fieldassociated with this search field configuration.booleanisSortDisabled()Returns whether sorting by the correspondingsearch fieldis disabled or not.booleanisVisible()Returns whether the correspondingsearch fieldshould be visible or not.voidsetConditionEntries(java.util.List<EditorConditionEntry> conditionEntries)voidsetEditor(java.lang.String editor)voidsetEntryListMode(SearchFieldConfiguration.EntryListMode entryListMode)voidsetName(java.lang.String name)Sets the name which the correspondingsearch fieldshould be given.voidsetParameters(java.util.Map<java.lang.String,java.lang.String> parameters)voidsetSortDisabled(boolean sortDisabled)Sets whether the correspondingsearch fieldshould allow sorting or not.voidsetVisible(boolean visible)Sets whether the correspondingsearch fieldshould be visibility or not.
-
-
-
Constructor Detail
-
PropertySearchFieldConfiguration
public PropertySearchFieldConfiguration(PropertyDescriptor propertyDescriptor)
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:SearchFieldConfigurationReturns the name set for this search field configuration.- Specified by:
getNamein interfaceSearchFieldConfiguration- Returns:
- the name of this search field configuration
-
getSearchField
public DefaultSearchField getSearchField()
Description copied from interface:SearchFieldConfigurationReturns thesearch fieldassociated with this search field configuration.- Specified by:
getSearchFieldin interfaceSearchFieldConfiguration- Returns:
- the search field associated with this search field configuration
-
isSortDisabled
public boolean isSortDisabled()
Description copied from interface:SearchFieldConfigurationReturns whether sorting by the correspondingsearch fieldis disabled or not.- Specified by:
isSortDisabledin interfaceSearchFieldConfiguration- Returns:
trueif sorting is disabled i.e. not allowed,falseotherwise
-
isVisible
public boolean isVisible()
Description copied from interface:SearchFieldConfigurationReturns whether the correspondingsearch fieldshould be visible or not.- Specified by:
isVisiblein interfaceSearchFieldConfiguration- Returns:
trueif the corresponding search field should be visible,falseotherwise
-
setName
public void setName(java.lang.String name)
Description copied from interface:SearchFieldConfigurationSets the name which the correspondingsearch fieldshould be given.- Specified by:
setNamein interfaceSearchFieldConfiguration- Parameters:
name- the name
-
setSortDisabled
public void setSortDisabled(boolean sortDisabled)
Description copied from interface:SearchFieldConfigurationSets whether the correspondingsearch fieldshould allow sorting or not.- Specified by:
setSortDisabledin interfaceSearchFieldConfiguration- Parameters:
sortDisabled-truemeans that sorting by the correspondingsearch fieldis not allowed.
-
setVisible
public void setVisible(boolean visible)
Description copied from interface:SearchFieldConfigurationSets whether the correspondingsearch fieldshould be visibility or not.- Specified by:
setVisiblein interfaceSearchFieldConfiguration- Parameters:
visible-truemeans visible, whereasfalsemeans invisible
-
getPropertyDescriptor
public PropertyDescriptor getPropertyDescriptor()
Description copied from interface:SearchFieldConfigurationReturns this field's property descriptor.- Specified by:
getPropertyDescriptorin interfaceSearchFieldConfiguration- Returns:
- the property descriptor associated with this field
-
getEditor
public java.lang.String getEditor()
- Specified by:
getEditorin interfaceSearchFieldConfiguration- Returns:
- the editor
-
setEditor
public void setEditor(java.lang.String editor)
- Specified by:
setEditorin interfaceSearchFieldConfiguration- Parameters:
editor- the editor to set
-
setParameters
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
- Specified by:
getParametersin interfaceSearchFieldConfiguration
-
getConditionEntries
public java.util.List<EditorConditionEntry> getConditionEntries()
- Specified by:
getConditionEntriesin interfaceSearchFieldConfiguration
-
getEntryListMode
public SearchFieldConfiguration.EntryListMode getEntryListMode()
- Specified by:
getEntryListModein interfaceSearchFieldConfiguration
-
setConditionEntries
public void setConditionEntries(java.util.List<EditorConditionEntry> conditionEntries)
-
setEntryListMode
public void setEntryListMode(SearchFieldConfiguration.EntryListMode entryListMode)
-
-