public interface

Dashboard

com.atlassian.jira.functest.framework.Dashboard

Class Overview

An abstraction for logically grouping JIRA dashboard functionality for functional tests. When used as a return value it also implies that the current location is the dashboard.

Summary

Nested Classes
class Dashboard.Table Holds the identifiers of the tables that display Portal Pages. 
Public Methods
Dashboard addPage(SharedEntityInfo info, Long cloneId)
Add the passed dashboard page to JIRA.
Dashboard disableConfigureMode()
Turns off configuration mode for the dashboard.
Dashboard editPage(SharedEntityInfo info)
Change the passed dashboard page in JIRA.
Dashboard enableConfigureMode()
Turns on configuration mode for the dashboard.
Dashboard favouriteDashboard(long id)
Make the passed dashboard one of the logged in user's favourites.
Long getDashboardPageId(String dashboardPageName, Locator pagesLocator)
Find the id of the dashboard page with the given name from a table to dashboard pages.
Dashboard navigateTo()
Navigates to the dashboard.
Dashboard navigateTo(long pageId)
Navigates to the a specific dashboard page.
Dashboard navigateToDefaultFullConfigure()
Open the default dashboard configuration.
Dashboard navigateToFavourites()
Navigate to the screen that shows favourite dashboards.
Dashboard navigateToFullConfigure(Long dashboardPageId)
Open the full configure screen for the passed dashboard.
Dashboard navigateToMy()
Navigate to the screen that shows my dashboards.
Dashboard navigateToPopular()
Navigate to the screen that shows popular dashboards.
Dashboard navigateToSearch()
Navigate to the screen that allows dashboard searching.
Dashboard resetToDefault()
Reset the dashboard configuration to its initial state.
Dashboard resetUserSessionState()
Reset user session state.
Dashboard unFavouriteDashboard(long id)
Remove the passed dashboard from the user's favourites.

Public Methods

public Dashboard addPage (SharedEntityInfo info, Long cloneId)

Add the passed dashboard page to JIRA.

Parameters
info the basic information for the dashboard.
cloneId the id of the dashboard to clone. Can be null to clone the blank dashboard.
Returns
  • the navigator object.

public Dashboard disableConfigureMode ()

Turns off configuration mode for the dashboard. If it is already off, it has no effect. Expects to be on the Dashboard to work.

Returns
  • itself.

public Dashboard editPage (SharedEntityInfo info)

Change the passed dashboard page in JIRA.

Parameters
info the basic information for the dashboard.
Returns
  • the navigator object.

public Dashboard enableConfigureMode ()

Turns on configuration mode for the dashboard. If it is already turned on, has no effect. If the current user has the default dashboard, subsequently they will have a custom dashboard, even though it will be configured the same as the default dashboard. Needs to be on the dashboard to work.

Returns
  • this in a FluentInterface style.

public Dashboard favouriteDashboard (long id)

Make the passed dashboard one of the logged in user's favourites.

Parameters
id the id of the dashboard to favourite.
Returns
  • this object so that the requests can be chained.

public Long getDashboardPageId (String dashboardPageName, Locator pagesLocator)

Find the id of the dashboard page with the given name from a table to dashboard pages.

Parameters
dashboardPageName the name of the dashboard to find.
pagesLocator the location of the table listing the dashboard.
Returns
  • the identifier if the dashboard page or null if no such page exists.

public Dashboard navigateTo ()

Navigates to the dashboard. Request to return to the location represented by this functional area.

Returns
  • itself.

public Dashboard navigateTo (long pageId)

Navigates to the a specific dashboard page. Request to return to the location represented by this functional area.

Parameters
pageId specific page
Returns
  • itself.

public Dashboard navigateToDefaultFullConfigure ()

Open the default dashboard configuration.

Returns
  • the navigation object.

public Dashboard navigateToFavourites ()

Navigate to the screen that shows favourite dashboards.

Returns
  • the navigator object.

public Dashboard navigateToFullConfigure (Long dashboardPageId)

Open the full configure screen for the passed dashboard.

Parameters
dashboardPageId the id of the dashboard to navigate to.
Returns
  • the navigator object.

public Dashboard navigateToMy ()

Navigate to the screen that shows my dashboards.

Returns
  • the navigator object.

public Dashboard navigateToPopular ()

Navigate to the screen that shows popular dashboards.

Returns
  • the navigator object.

public Dashboard navigateToSearch ()

Navigate to the screen that allows dashboard searching.

Returns
  • the navigator object.

public Dashboard resetToDefault ()

Reset the dashboard configuration to its initial state.

Returns
  • this object so that the requests can be chained.

public Dashboard resetUserSessionState ()

Reset user session state.

Returns
  • this object so that the requests can be chained.

public Dashboard unFavouriteDashboard (long id)

Remove the passed dashboard from the user's favourites.

Parameters
id the id of the dashboard to unfavourite.
Returns
  • this object so that the requests can be chained.