com.atlassian.jira.functest.framework.navigation
Interface FilterNavigation

All Known Implementing Classes:
FilterPickerPopupNavigation, ManageFiltersNavigation

public interface FilterNavigation

Navigate filter functionality.

Since:
v3.13

Method Summary
 void addFavourite(int id)
          Add filter as favourite to the current logged in user.
 void allFilters()
          Navigate to manage all filters
 long createFilter(String filterName, String filterDesc)
          Creates a filter with the specified name and description
 void deleteFilter(int id)
          Delete the specified filter.
 void favouriteFilters()
          Navigate to favourite filters.
 void findFilters(String filterName)
          Does a filter search from a filter search form page with the given search criteria.
 String getActionBaseUrl()
          Return the basic URL of the action.
 void goToDefault()
          Navigate to the default filters page for this FilterNavigation.
 void manageSubscriptions(int filterId)
          Navigate to manage subscriptions for a given filter
 void myFilters()
          Navigate to manage my filters
 void popularFilters()
          Navigate to manage popular filters
 FilterNavigation projects()
          Goes to the project tab of the filterpicker popup (only visible with showProjects param).
 void removeFavourite(int id)
          Remove filter as favourite from the current logged in user.
 List<FilterItem> 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.
 List<FilterItem> 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).
 void searchFilters()
          Navigate to search filters
 

Method Detail

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

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


createFilter

long createFilter(String filterName,
                  String filterDesc)
Creates a filter with the specified name and description

Parameters:
filterName - the name of the filter.
filterDesc - the description of the filter.
Returns:
the id of the newly created filter

deleteFilter

void deleteFilter(int id)
Delete the specified filter.

Parameters:
id - the id of the filter to delete.

findFilters

void findFilters(String filterName)
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

List<FilterItem> 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).

Parameters:
expectedItems - the template items to expect.
Returns:
equivalent expected items for this search results view.

sanitiseFavouriteFilterItems

List<FilterItem> 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.

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.


Copyright © 2002-2013 Atlassian. All Rights Reserved.