de.hybris.platform.cockpit.services.config.impl

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 and Description
PropertySearchFieldConfiguration(PropertyDescriptor propertyDescriptor)

Method Summary

Modifier and Type	Method and Description
java.util.List<EditorConditionEntry>	getConditionEntries()
java.lang.String	getEditor()
SearchFieldConfiguration.EntryListMode	getEntryListMode()
java.lang.String	getName() Returns the name set for this search field configuration.
java.util.Map<java.lang.String,java.lang.String>	getParameters()
PropertyDescriptor	getPropertyDescriptor() Returns this field's property descriptor.
DefaultSearchField	getSearchField() Returns the search field associated with this search field configuration.
boolean	isSortDisabled() Returns whether sorting by the corresponding search field is disabled or not.
boolean	isVisible() Returns whether the corresponding search field should be visible or not.
void	setConditionEntries(java.util.List<EditorConditionEntry> conditionEntries)
void	setEditor(java.lang.String editor)
void	setEntryListMode(SearchFieldConfiguration.EntryListMode entryListMode)
void	setName(java.lang.String name) Sets the name which the corresponding search field should be given.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
void	setSortDisabled(boolean sortDisabled) Sets whether the corresponding search field should allow sorting or not.
void	setVisible(boolean visible) Sets whether the corresponding search field should be visibility or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySearchFieldConfiguration

public PropertySearchFieldConfiguration(PropertyDescriptor propertyDescriptor)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: SearchFieldConfiguration

Returns the name set for this search field configuration.

Specified by:

getName in interface SearchFieldConfiguration

Returns:

the name of this search field configuration

getSearchField

public DefaultSearchField getSearchField()

Description copied from interface: SearchFieldConfiguration

Returns the search field associated with this search field configuration.

Specified by:

getSearchField in interface SearchFieldConfiguration

Returns:

the search field associated with this search field configuration

isSortDisabled

public boolean isSortDisabled()

Description copied from interface: SearchFieldConfiguration

Returns whether sorting by the corresponding search field is disabled or not.

Specified by:

isSortDisabled in interface SearchFieldConfiguration

Returns:

true if sorting is disabled i.e. not allowed, false otherwise

isVisible

public boolean isVisible()

Description copied from interface: SearchFieldConfiguration

Returns whether the corresponding search field should be visible or not.

Specified by:

isVisible in interface SearchFieldConfiguration

Returns:

true if the corresponding search field should be visible, false otherwise

setName

public void setName(java.lang.String name)

Description copied from interface: SearchFieldConfiguration

Sets the name which the corresponding search field should be given.

Specified by:

setName in interface SearchFieldConfiguration

Parameters:

name - the name

setSortDisabled

public void setSortDisabled(boolean sortDisabled)

Description copied from interface: SearchFieldConfiguration

Sets whether the corresponding search field should allow sorting or not.

Specified by:

setSortDisabled in interface SearchFieldConfiguration

Parameters:

sortDisabled - true means that sorting by the corresponding search field is not allowed.

setVisible

public void setVisible(boolean visible)

Description copied from interface: SearchFieldConfiguration

Sets whether the corresponding search field should be visibility or not.

Specified by:

setVisible in interface SearchFieldConfiguration

Parameters:

visible - true means visible, whereas false means invisible

getPropertyDescriptor

public PropertyDescriptor getPropertyDescriptor()

Description copied from interface: SearchFieldConfiguration

Returns this field's property descriptor.

Specified by:

getPropertyDescriptor in interface SearchFieldConfiguration

Returns:

the property descriptor associated with this field

getEditor

public java.lang.String getEditor()

Specified by:

getEditor in interface SearchFieldConfiguration

Returns:

the editor

setEditor

public void setEditor(java.lang.String editor)

Specified by:

setEditor in interface SearchFieldConfiguration

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:

getParameters in interface SearchFieldConfiguration

getConditionEntries

public java.util.List<EditorConditionEntry> getConditionEntries()

Specified by:

getConditionEntries in interface SearchFieldConfiguration

getEntryListMode

public SearchFieldConfiguration.EntryListMode getEntryListMode()

Specified by:

getEntryListMode in interface SearchFieldConfiguration

setConditionEntries

public void setConditionEntries(java.util.List<EditorConditionEntry> conditionEntries)

setEntryListMode

public void setEntryListMode(SearchFieldConfiguration.EntryListMode entryListMode)