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:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetName()Returns the name set for this search field configuration.Returns this field's property descriptor.Returns thesearch fieldassociated with this search field configuration.booleanReturns whether sorting by the correspondingsearch fieldis disabled or not.booleanReturns whether the correspondingsearch fieldshould be visible or not.voidvoidSets the name which the correspondingsearch fieldshould be given.voidsetSortDisabled(boolean sortDisabled) Sets whether the correspondingsearch fieldshould allow sorting or not.voidsetVisible(boolean visible) Sets whether the correspondingsearch fieldshould be visibility or not.
-
Field Details
-
CONDITION_ENTRIES
- See Also:
-
ENTRY_LIST_MODE
- See Also:
-
-
Method Details
-
setName
Sets the name which the correspondingsearch fieldshould be given.- Parameters:
name- the name
-
getName
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 correspondingsearch fieldshould be visibility or not.- Parameters:
visible-truemeans visible, whereasfalsemeans invisible
-
isVisible
boolean isVisible()Returns whether the correspondingsearch fieldshould be visible or not.- Returns:
trueif the corresponding search field should be visible,falseotherwise
-
setSortDisabled
void setSortDisabled(boolean sortDisabled) Sets whether the correspondingsearch fieldshould allow sorting or not.- Parameters:
sortDisabled-truemeans that sorting by the correspondingsearch fieldis not allowed.
-
isSortDisabled
boolean isSortDisabled()Returns whether sorting by the correspondingsearch fieldis disabled or not.- Returns:
trueif sorting is disabled i.e. not allowed,falseotherwise
-
getSearchField
DefaultSearchField getSearchField()Returns thesearch fieldassociated 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
String getEditor() -
setEditor
-
getParameters
-
getConditionEntries
List<EditorConditionEntry> getConditionEntries() -
getEntryListMode
SearchFieldConfiguration.EntryListMode getEntryListMode()
-