org.nuxeo.ecm.webapp.dashboard
Interface DashboardActions

All Superinterfaces:

ResultsProviderFarm, java.io.Serializable

All Known Implementing Classes:

DashBoardActionsBean

public interface DashboardActions
extends java.io.Serializable, ResultsProviderFarm

Dashboard actions listener.

Handles user documents an tasks.

Author:

Julien Anguenot

Method Summary

java.util.Collection<DashBoardItem>	computeDashboardItems() Computes dashboard items.
java.util.Collection<DocumentProcessItem>	computeDocumentProcessItems() Computes the document process items.
void	destroy()
java.lang.String	doSearch()
java.util.List<DocumentModel>	getAvailableDomains()
DocumentModelList	getLastModifiedDocuments() Computes the list of documents recently modified in the current domain if any.
DocumentModel	getSelectedDomain()
java.lang.String	getSelectedDomainId()
SortInfo	getSortInfo()
DocumentModelList	getUserDocuments() Computes the list of documents recently edited by the current user.
DocumentModelList	getUserWorkspaces() Computes the list of workspaces the user has the right to see.
void	invalidateAvailableDomains()
void	invalidateDashboardItems() Invalidates dashboard items.
void	invalidateDocumentProcessItems() Invalidates document process items.
void	invalidateDomainBoundInfo()
void	invalidateDomainResultProviders()
java.lang.String	navigateToDocumentTab(DocumentModel dm) Navigates to the a given tab.
java.lang.String	refreshDashboardItems()
java.lang.String	refreshDocumentProcessItems()
void	setSelectedDomainId(java.lang.String selectedDomainId)
java.lang.String	submitSelectedDomainChange()
java.lang.String	viewDashboard() View dashboard.

Methods inherited from interface org.nuxeo.ecm.platform.ui.web.api.ResultsProviderFarm

getResultsProvider, getResultsProvider

Method Detail

invalidateDashboardItems

void invalidateDashboardItems()

Invalidates dashboard items.

See Also:

Observer

computeDashboardItems

java.util.Collection<DashBoardItem> computeDashboardItems()
                                                          throws ClientException

Computes dashboard items.

Returns:

a collection of dashboard items.

Throws:

ClientException

See Also:

factory

computeDocumentProcessItems

java.util.Collection<DocumentProcessItem> computeDocumentProcessItems()
                                                                      throws ClientException

Computes the document process items.

Returns:

a collection

Throws:

ClientException

See Also:

factory

invalidateDocumentProcessItems

void invalidateDocumentProcessItems()

Invalidates document process items.

See Also:

Observer

viewDashboard

java.lang.String viewDashboard()

View dashboard.

getUserDocuments

DocumentModelList getUserDocuments()

Computes the list of documents recently edited by the current user.

getLastModifiedDocuments

DocumentModelList getLastModifiedDocuments()
                                           throws ClientException

Computes the list of documents recently modified in the current domain if any.

Returns:

XXX

Throws:

ClientException

getUserWorkspaces

DocumentModelList getUserWorkspaces()

Computes the list of workspaces the user has the right to see.

navigateToDocumentTab

java.lang.String navigateToDocumentTab(DocumentModel dm)
                                       throws ClientException

Navigates to the a given tab.

Parameters:

dm - document model

Returns:

a navigation id.

Throws:

ClientException

refreshDashboardItems

java.lang.String refreshDashboardItems()

refreshDocumentProcessItems

java.lang.String refreshDocumentProcessItems()

doSearch

java.lang.String doSearch()

getSortInfo

SortInfo getSortInfo()

invalidateDomainBoundInfo

void invalidateDomainBoundInfo()
                               throws ClientException

Throws:

ClientException

invalidateDomainResultProviders

void invalidateDomainResultProviders()
                                     throws ClientException

Throws:

ClientException

getSelectedDomain

DocumentModel getSelectedDomain()
                                throws ClientException

Throws:

ClientException

getAvailableDomains

java.util.List<DocumentModel> getAvailableDomains()
                                                  throws ClientException

Throws:

ClientException

invalidateAvailableDomains

void invalidateAvailableDomains()
                                throws ClientException

Throws:

ClientException

getSelectedDomainId

java.lang.String getSelectedDomainId()
                                     throws ClientException

Throws:

ClientException

setSelectedDomainId

void setSelectedDomainId(java.lang.String selectedDomainId)
                         throws ClientException

Throws:

ClientException

submitSelectedDomainChange

java.lang.String submitSelectedDomainChange()
                                            throws ClientException

Throws:

ClientException

destroy

@Destroy
void destroy()