Interface FilterNavigation
- All Known Implementing Classes:
FilterPickerPopupNavigation,ManageFiltersNavigation
public interface FilterNavigation
Navigate filter functionality.
- Since:
- v3.13
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddFavourite(int id) Add filter as favourite to the current logged in user.voidaddSubscription(int filterId) voidNavigate to manage all filtersvoiddeleteFilter(int id) Delete the specified filter.voidNavigate to favourite filters.voidfindFilters(String filterName) Does a filter search from a filter search form page with the given search criteria.Return the basic URL of the action.voidNavigate to the default filters page for this FilterNavigation.voidmanageSubscriptions(int filterId) Navigate to manage subscriptions for a given filtervoidNavigate to manage my filtersvoidNavigate to manage popular filtersprojects()Goes to the project tab of the filterpicker popup (only visible with showProjects param).voidremoveFavourite(int id) Remove filter as favourite from the current logged in user.sanitiseFavouriteFilterItems(List<FilterItem> expectedItems) Return a new list containing new expected items based on the given ones which are stripped of any field expectations that are not designed to be met by this FilterNavigation implementation's favourite view.sanitiseSearchFilterItems(List<FilterItem> expectedItems) Return a new list containing new expected items based on the given ones which are stripped of any field expectations that are not designed to be met by this FilterNavigation implementation's search results view (including popular filters).voidNavigate to search filters
-
Method Details
-
addFavourite
void addFavourite(int id) Add filter as favourite to the current logged in user.- Parameters:
id- The id of the filter
-
removeFavourite
void removeFavourite(int id) Remove filter as favourite from the current logged in user.- Parameters:
id- The id of the filter
-
goToDefault
void goToDefault()Navigate to the default filters page for this FilterNavigation. -
manageSubscriptions
void manageSubscriptions(int filterId) Navigate to manage subscriptions for a given filter- Parameters:
filterId- id of the filter
-
addSubscription
void addSubscription(int filterId) -
favouriteFilters
void favouriteFilters()Navigate to favourite filters. -
myFilters
void myFilters()Navigate to manage my filters -
allFilters
void allFilters()Navigate to manage all filters -
popularFilters
void popularFilters()Navigate to manage popular filters -
searchFilters
void searchFilters()Navigate to search filters -
deleteFilter
void deleteFilter(int id) Delete the specified filter.- Parameters:
id- the id of the filter to delete.
-
findFilters
Does a filter search from a filter search form page with the given search criteria. Client is left on filter search results screen.- Parameters:
filterName- the name of the filter, possibly "" but not null.
-
sanitiseSearchFilterItems
Return a new list containing new expected items based on the given ones which are stripped of any field expectations that are not designed to be met by this FilterNavigation implementation's search results view (including popular filters).- Parameters:
expectedItems- the template items to expect.- Returns:
- equivalent expected items for this search results view.
-
sanitiseFavouriteFilterItems
Return a new list containing new expected items based on the given ones which are stripped of any field expectations that are not designed to be met by this FilterNavigation implementation's favourite view.- Parameters:
expectedItems- the template items to expect.- Returns:
- equivalent expected items for this favourite filters view.
-
getActionBaseUrl
String getActionBaseUrl()Return the basic URL of the action.- Returns:
- this.
-
projects
FilterNavigation projects()Goes to the project tab of the filterpicker popup (only visible with showProjects param).- Returns:
- this.
-