com.atlassian.confluence.it.dashboard
Interface Dashboard

All Known Implementing Classes:
WebDashboard

public interface Dashboard

Represents the information shown on the Confluence dashboard.


Field Summary
static String DEFAULT_WELCOME_MESSAGE
           
 
Method Summary
 int countChangeSets()
           
 int countUpdateItems()
           
 RecentlyUpdatedChangeSet getRecentUpdate(int changeSetIndex)
          Returns the recently updated change-set at the specified index on the dashboard, or null if such an item does not exist.
 List 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.
 

Field Detail

DEFAULT_WELCOME_MESSAGE

static final String DEFAULT_WELCOME_MESSAGE
See Also:
Constant Field Values
Method Detail

getRecentUpdates

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

Returns:
a list of RecentlyUpdatedChangeSet objects.

getRecentUpdate

RecentlyUpdatedChangeSet getRecentUpdate(int changeSetIndex)
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.

Parameters:
changeSetIndex - 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

Date getRequestTime()
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.


countUpdateItems

int countUpdateItems()
Returns:
the number of update items (not change sets) on the dashboard page.

countChangeSets

int countChangeSets()
Returns:
the number of change sets on the dashboard page


Copyright © 2003-2013 Atlassian. All Rights Reserved.