Interface AdvancedSearchModel
-
- All Known Implementing Classes:
AbstractAdvancedSearchModel
,DefaultAdvancedSearchModel
public interface AdvancedSearchModel
AnAdvancedSearchModel
holds information about which search fields are available, visible, sortable etc. It is ment to act as view model for view components which represent an advanced search mask.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UIEditor
getEditor(SearchField searchField)
Returns theeditor
for a specificsearch field
.java.util.List<SearchField>
getHiddenSearchFields()
Returns all the available hidden search fields.AdvancedSearchParameterContainer
getParameterContainer()
java.util.Map<java.lang.String,java.lang.String>
getParametersForSearchField(SearchField searchField)
PropertyDescriptor
getPropertyDescriptor(SearchField field)
SearchFieldGroup
getRootSearchFieldGroup()
Returns the rootsearch field group
.java.util.List<SearchField>
getSearchFields()
Returns all the available search fields.ObjectTemplate
getSelectedType()
Returns the currently selected type i.e.java.util.List<PropertyDescriptor>
getSortableProperties()
Returns all the properties which can currently be used for sorting.PropertyDescriptor
getSortedByProperty()
Returns the property by which search result should be sorted.java.util.List<ObjectTemplate>
getTypes()
Returns all the types supported by this advanced search.java.util.List<SearchField>
getVisibleSearchFields()
Returns all the available visible search fields.boolean
isSortAscending()
Returns whether search result is sorted ascending or not.void
resetToInitialSearchParameters()
Method cleans search fields and sets type as rootType
-
-
-
Method Detail
-
getParameterContainer
AdvancedSearchParameterContainer getParameterContainer()
-
getRootSearchFieldGroup
SearchFieldGroup getRootSearchFieldGroup()
Returns the rootsearch field group
.- Returns:
- the root group containing
search fields
and other groups in a hierarchical structure.
-
getSelectedType
ObjectTemplate getSelectedType()
Returns the currently selected type i.e. the type of the items which are being searched for.- Returns:
- the active type
-
getTypes
java.util.List<ObjectTemplate> getTypes()
Returns all the types supported by this advanced search.- Returns:
- list containing all the available search types
-
getSearchFields
java.util.List<SearchField> getSearchFields()
Returns all the available search fields.- Returns:
- all the available search fields
- See Also:
getRootSearchFieldGroup()
,getVisibleSearchFields()
,getHiddenSearchFields()
-
getVisibleSearchFields
java.util.List<SearchField> getVisibleSearchFields()
Returns all the available visible search fields.- Returns:
- all the available search fields which are currently visible
- See Also:
getSearchFields()
,getHiddenSearchFields()
-
getHiddenSearchFields
java.util.List<SearchField> getHiddenSearchFields()
Returns all the available hidden search fields.- Returns:
- all the available search fields which are currently hidden
- See Also:
getSearchFields()
,getVisibleSearchFields()
-
getSortableProperties
java.util.List<PropertyDescriptor> getSortableProperties()
Returns all the properties which can currently be used for sorting.- Returns:
- all the available properties which can be used for sorting
-
getSortedByProperty
PropertyDescriptor getSortedByProperty()
Returns the property by which search result should be sorted.- Returns:
- the property to be used for sorting
-
isSortAscending
boolean isSortAscending()
Returns whether search result is sorted ascending or not.- Returns:
true
if ascending,false
if descending
-
getEditor
UIEditor getEditor(SearchField searchField)
Returns theeditor
for 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
-
getPropertyDescriptor
PropertyDescriptor getPropertyDescriptor(SearchField field)
-
resetToInitialSearchParameters
void resetToInitialSearchParameters()
Method cleans search fields and sets type as rootType
-
getParametersForSearchField
java.util.Map<java.lang.String,java.lang.String> getParametersForSearchField(SearchField searchField)
- Returns:
- parameters for search field
-
-