de.hybris.platform.cockpit.services.config

Interface SearchFieldConfiguration

All Known Implementing Classes:

PropertySearchFieldConfiguration

public interface SearchFieldConfiguration

Represents a search field in terms of configuration. Responsible for creating the corresponding SearchField view model object.

See Also:

SearchField

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SearchFieldConfiguration.EntryListMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONDITION_ENTRIES
static java.lang.String	ENTRY_LIST_MODE

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	setEditor(java.lang.String editor)
void	setName(java.lang.String name) Sets the name which the corresponding search field should be given.
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.

Field Detail

CONDITION_ENTRIES

static final java.lang.String CONDITION_ENTRIES

See Also:

Constant Field Values

ENTRY_LIST_MODE

static final java.lang.String ENTRY_LIST_MODE

See Also:

Constant Field Values

Method Detail

setName

void setName(java.lang.String name)

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

Parameters:

name - the name

getName

java.lang.String getName()

Returns the name set for this search field configuration.

Returns:

the name of this search field configuration

setVisible

void setVisible(boolean visible)

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

Parameters:

visible - true means visible, whereas false means invisible

isVisible

boolean isVisible()

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

Returns:

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

setSortDisabled

void setSortDisabled(boolean sortDisabled)

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

Parameters:

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

isSortDisabled

boolean isSortDisabled()

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

Returns:

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

getSearchField

DefaultSearchField getSearchField()

Returns the search field associated with this search field configuration.

Returns:

the search field associated with this search field configuration

getPropertyDescriptor

PropertyDescriptor getPropertyDescriptor()

Returns this field's property descriptor.

Returns:

the property descriptor associated with this field

getEditor

java.lang.String getEditor()

setEditor

void setEditor(java.lang.String editor)

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

getConditionEntries

java.util.List<EditorConditionEntry> getConditionEntries()

getEntryListMode

SearchFieldConfiguration.EntryListMode getEntryListMode()