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

All Known Implementing Classes:

IssueNavigatorNavigationImpl

public interface IssueNavigatorNavigation

Navigate issueNavigator functionality

Since:

v3.13

Nested Class Summary

static class	IssueNavigatorNavigation.BulkChangeOption Options for performing a bulk change on the current search results.
static class	IssueNavigatorNavigation.NavigatorEditMode The edit mode for the navigator.
static class	IssueNavigatorNavigation.NavigatorMode The modes that navigator may be in.

Method Summary

void	addColumnToIssueNavigator(String[] fieldNames) Adds the extra columns to the Issue Navigator
BulkChangeWizard	bulkChange(IssueNavigatorNavigation.BulkChangeOption bulkChangeOption) Initiate the bulk change wizard on the current search results.
void	clickEditModeFlipLink() Clicks the link that flips between simple and advanced navigator edit modes.
long	createNewAndSaveAsFilter(SharedEntityInfo info, NavigatorSearch search) Create and save the passed search.
void	createSearch(NavigatorSearch search) Create a search with the passed parameters.
IssueNavigatorNavigation	createSearch(String jqlQuery) Switches the navigator into Advanced mode, and then executes the specified JQL query.
void	deleteFilter(long id) Delete the listed filter.
void	displayAllIssues() Runs a search on all issues.
void	expandAllNavigatorSections() Expand all of the navigator sections.
void	expandNavigatorSection(String sectionId) Expand the passed navigator section.
IssueNavigatorNavigation.NavigatorEditMode	getCurrentEditMode() Returns the edit mode that issue navigator is in.
IssueNavigatorNavigation.NavigatorMode	getCurrentMode() Returns the mode that issue navigator is currently in.
void	goToConfigureColumns() Go to the configure columns screen.
void	gotoEditMode(IssueNavigatorNavigation.NavigatorEditMode mode) Switch the navigator into Edit mode.
IssueNavigatorNavigation.NavigatorMode	gotoEditOrNewMode(IssueNavigatorNavigation.NavigatorEditMode mode) Switch to the passed edit mode in navigator.
void	gotoNavigator() Navigators to the issue navigation
void	gotoNewMode(IssueNavigatorNavigation.NavigatorEditMode navigatorEditMode) Switch the navigator into New mode.
void	gotoViewMode() Switch the navigator into View mode.
void	hideActionsColumn() Hide the actions column on the issue navigator.
void	loadFilter(long id) Loads a filter in the issue navigator in summary mode.
void	loadFilter(long id, IssueNavigatorNavigation.NavigatorEditMode mode) Loads a filter in the issue navigator in edit mode.
void	modifySearch(NavigatorSearch search) Modify the current search.
void	restoreColumnDefaults() Restore the default columns in the Issue Navigator.
IssueSearchPage	runPrintableSearch(String jqlQuery)
void	runSearch() Run the current search.
IssueSearchPage	runSearch(String jqlQuery)
List<String>	runSimpleSearch(String jqlQuery) Safely run a search, ignoring errors and returning only the matching issue keys in the order that they were returned.
void	runXmlSearch(String jqlQuery, String... fields)
long	saveCurrentAsNewFilter(SharedEntityInfo info) Save the current search and new filter.
long	saveCurrentAsNewFilter(String name, String description, boolean favourite, Set<? extends TestSharingPermission> permissions) Save current search as new filter.
long	saveCurrentFilter() Save the current filter.
void	showActionsColumn() Show the actions column on the issue navigator.
void	sortIssues(String field, String direction) Sort the Issues in the navigator

Method Detail

getCurrentMode

IssueNavigatorNavigation.NavigatorMode getCurrentMode()

Returns the mode that issue navigator is currently in.

Returns:

the mode that issue navigator is currently in. Null if we can't work it out.

getCurrentEditMode

IssueNavigatorNavigation.NavigatorEditMode getCurrentEditMode()

Returns the edit mode that issue navigator is in.

Returns:

the edit mode that issue navigator is in. Null if we can't work it out.

gotoNavigator

void gotoNavigator()

Navigators to the issue navigation

displayAllIssues

void displayAllIssues()

Runs a search on all issues.

sortIssues

void sortIssues(String field,
                String direction)

Sort the Issues in the navigator

Parameters:

field - The name of the field that should be used to sort the issues.

direction - a String representing the sorting direction. The allowed values are "ASC" or "DESC".

loadFilter

void loadFilter(long id)

Loads a filter in the issue navigator in summary mode.

Parameters:

id - The id of the filter to load.

loadFilter

void loadFilter(long id,
                IssueNavigatorNavigation.NavigatorEditMode mode)

Loads a filter in the issue navigator in edit mode.

Parameters:

id - the id of the filter to load.

mode - the navigator edit mode to enter into.

gotoEditMode

void gotoEditMode(IssueNavigatorNavigation.NavigatorEditMode mode)

Switch the navigator into Edit mode. The mode of the edit can be specified in the passed argument.

Parameters:

mode - the mode to load the navigator into. Null indicates that we should goto the current mode.

clickEditModeFlipLink

void clickEditModeFlipLink()

Clicks the link that flips between simple and advanced navigator edit modes. Assumes we are currently "editing" a filer.

gotoViewMode

void gotoViewMode()

Switch the navigator into View mode.

gotoNewMode

void gotoNewMode(IssueNavigatorNavigation.NavigatorEditMode navigatorEditMode)

Switch the navigator into New mode.

Parameters:

navigatorEditMode - the editing mode to go into; may be null to use current.

gotoEditOrNewMode

IssueNavigatorNavigation.NavigatorMode gotoEditOrNewMode(IssueNavigatorNavigation.NavigatorEditMode mode)

Switch to the passed edit mode in navigator. If there is a current search it will move into IssueNavigatorNavigation.NavigatorMode.EDIT. If there is not current search it will move into IssueNavigatorNavigation.NavigatorMode.NEW.

Parameters:

mode - the edit mode to switch into.

Returns:

the mode navigator switched into.

runSearch

IssueSearchPage runSearch(String jqlQuery)

runPrintableSearch

IssueSearchPage runPrintableSearch(String jqlQuery)

runXmlSearch

void runXmlSearch(String jqlQuery,
                  String... fields)

runSimpleSearch

List<String> runSimpleSearch(String jqlQuery)

Safely run a search, ignoring errors and returning only the matching issue keys in the order that they were returned.

Parameters:

jqlQuery - the JQL query to run

Returns:

the list of values returned (never null)

createSearch

IssueNavigatorNavigation createSearch(String jqlQuery)

Switches the navigator into Advanced mode, and then executes the specified JQL query.

Parameters:

jqlQuery - the query to be executed

Returns:

this object

createSearch

void createSearch(NavigatorSearch search)

Create a search with the passed parameters.

Parameters:

search - the search to create.

modifySearch

void modifySearch(NavigatorSearch search)

Modify the current search.

Parameters:

search - make the current search look like this.

createNewAndSaveAsFilter

long createNewAndSaveAsFilter(SharedEntityInfo info,
                              NavigatorSearch search)

Create and save the passed search.

Parameters:

info - the details of the search to create and save.

search - the search to create and save.

Returns:

the id of the search just created.

saveCurrentAsNewFilter

long saveCurrentAsNewFilter(SharedEntityInfo info)

Save the current search and new filter.

Parameters:

info - information used to save the search.

Returns:

the id of the search just created.

saveCurrentAsNewFilter

long saveCurrentAsNewFilter(String name,
                            String description,
                            boolean favourite,
                            Set<? extends TestSharingPermission> permissions)

Save current search as new filter.

Parameters:

name - name of the search.

description - of the search.

favourite - should the search going to be saved as a favourite?

permissions - the share permissions to associate with the current search.

Returns:

the id of the search just created.

saveCurrentFilter

long saveCurrentFilter()

Save the current filter.

Returns:

the id of the search just saved.

deleteFilter

void deleteFilter(long id)

Delete the listed filter.

Parameters:

id - the id of the filter to delete.

hideActionsColumn

void hideActionsColumn()

Hide the actions column on the issue navigator.

showActionsColumn

void showActionsColumn()

Show the actions column on the issue navigator.

addColumnToIssueNavigator

void addColumnToIssueNavigator(String[] fieldNames)

Adds the extra columns to the Issue Navigator

Parameters:

fieldNames - The name of the field to be added as columns to the issue navigator.

restoreColumnDefaults

void restoreColumnDefaults()

Restore the default columns in the Issue Navigator.

runSearch

void runSearch()

Run the current search.

expandAllNavigatorSections

void expandAllNavigatorSections()

Expand all of the navigator sections.

expandNavigatorSection

void expandNavigatorSection(String sectionId)

Expand the passed navigator section.

Parameters:

sectionId - the section to expand.

bulkChange

BulkChangeWizard bulkChange(IssueNavigatorNavigation.BulkChangeOption bulkChangeOption)

Initiate the bulk change wizard on the current search results.

Parameters:

bulkChangeOption - whether to bulk change all results or just the current page.

Returns:

an instance of the bulk change wizard which will be used to step through the wizard.

goToConfigureColumns

void goToConfigureColumns()

Go to the configure columns screen.