Package com.atlassian.confluence.it.dashboard

Class WebDashboard

java.lang.Object

com.atlassian.confluence.it.dashboard.WebDashboard

All Implemented Interfaces:

Dashboard

public class WebDashboard
extends Object
implements Dashboard

Confluence dashboard information retrieved from the web interface via a WebTester.

Field Summary

Fields inherited from interface com.atlassian.confluence.it.dashboard.Dashboard

DEFAULT_WELCOME_MESSAGE

Method Summary

Modifier and Type	Method	Description
void	assertTabNotVisible(String tab)
void	assertTabVisible(String tab)
int	countChangeSets()
int	countUpdateItems()
static WebDashboard	getDashboard()	Defaults to the "All" tab for the recently updated section
static WebDashboard	getDashboard(Map<String,Object> params)
static WebDashboard	getDashboard(Map<String,Object> params, net.sourceforge.jwebunit.junit.WebTester tester)
static WebDashboard	getDashboard(net.sourceforge.jwebunit.junit.WebTester tester)
static WebDashboard	getDashboardUpdatesMacroOnPage(AbstractPageEntity page)
static WebDashboard	getDashboardUpdatesMacroOnPage(AbstractPageEntity page, Map<String,Object> params)
int	getItemsWithMatchingTitle(String title)
RecentlyUpdatedChangeSet	getRecentUpdate(int index)	Returns the recently updated change-set at the specified index on the dashboard, or null if such an item does not exist.
List<RecentlyUpdatedChangeSet>	getRecentUpdates()	Returns the recently updated content from the dashboard as RecentlyUpdatedChangeSet objects in the order they appear on the dashboard.
Date	getRequestTime()	Returns the request timestamp inserted by the server in a meta tag in the HTML header.
String	getSelectedTabName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDashboard

public static WebDashboard getDashboard(Map<String,Object> params)

getDashboard

public static WebDashboard getDashboard(Map<String,Object> params,
                                        net.sourceforge.jwebunit.junit.WebTester tester)

getDashboardUpdatesMacroOnPage

public static WebDashboard getDashboardUpdatesMacroOnPage(AbstractPageEntity page,
                                                          Map<String,Object> params)

getDashboardUpdatesMacroOnPage

public static WebDashboard getDashboardUpdatesMacroOnPage(AbstractPageEntity page)

getDashboard

public static WebDashboard getDashboard()

Defaults to the "All" tab for the recently updated section

getDashboard

public static WebDashboard getDashboard(net.sourceforge.jwebunit.junit.WebTester tester)

getRecentUpdates

public List<RecentlyUpdatedChangeSet> getRecentUpdates()

Description copied from interface: Dashboard

Returns the recently updated content from the dashboard as RecentlyUpdatedChangeSet objects in the order they appear on the dashboard.

Specified by:

getRecentUpdates in interface Dashboard

Returns:

a list of RecentlyUpdatedChangeSet objects.

getRecentUpdate

public RecentlyUpdatedChangeSet getRecentUpdate(int index)

Description copied from interface: Dashboard

Returns the recently updated change-set at the specified index on the dashboard, or null if such an item does not exist. An index of zero indicates the first (i.e. most recent) changeset on the list.

Specified by:

getRecentUpdate in interface Dashboard

Parameters:

index - the zero-based index of the recently updated change-set on dashboard to return.

Returns:

the recently updated change-set on the dashboard with the specified index, or null if one does not exist.

getRequestTime

public Date getRequestTime()

Description copied from interface: Dashboard

Returns the request timestamp inserted by the server in a meta tag in the HTML header. Useful for checking times on recent updates. Returns null if the meta tag is not found.

Specified by:

getRequestTime in interface Dashboard

countUpdateItems

public int countUpdateItems()

Specified by:

countUpdateItems in interface Dashboard

Returns:

the number of update items (not change sets) on the dashboard page.

countChangeSets

public int countChangeSets()

Specified by:

countChangeSets in interface Dashboard

Returns:

the number of change sets on the dashboard page

getItemsWithMatchingTitle

public int getItemsWithMatchingTitle(String title)

Parameters:

title - Title to look for

Returns:

number of recently updated items with the given title.

assertTabVisible

public void assertTabVisible(String tab)

assertTabNotVisible

public void assertTabNotVisible(String tab)

getSelectedTabName

public String getSelectedTabName()