org.nuxeo.ecm.webapp.dashboard

Class DashBoardActionsBean

java.lang.Object

org.nuxeo.ecm.webapp.dashboard.DashBoardActionsBean

All Implemented Interfaces:

Serializable, ResultsProviderFarm, DashboardActions

@Name(value="dashboardActions")
@Scope(value=CONVERSATION)
@Install(precedence=10)
public class DashBoardActionsBean
extends Object
implements DashboardActions

Dash board actions.

Those actions are related to the current authenticated principal.

Author:

Julien Anguenot

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DashBoardActionsBean()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<DashBoardItem>	computeDashboardItems() Computes dashboard items.
Collection<DocumentProcessItem>	computeDocumentProcessItems() Computes the document process items.
void	destroy()
String	doSearch()
List<DocumentModel>	getAvailableDomains()
DocumentModelList	getLastModifiedDocuments() Computes the list of documents recently modified in the current domain if any.
PagedDocumentsProvider	getResultsProvider(String name) Makes a new, fresh instance of the named results provider.
PagedDocumentsProvider	getResultsProvider(String name, SortInfo sortInfo)
DocumentModel	getSelectedDomain()
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()
String	navigateToDocumentTab(DocumentModel dm) Navigates to the a given tab.
String	refreshDashboardItems()
String	refreshDocumentProcessItems()
String	refreshProvider(String providerName)
void	setSelectedDomainId(String selectedDomainId)
String	submitSelectedDomainChange()
String	viewDashboard() View dashboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashBoardActionsBean

public DashBoardActionsBean()

Method Detail

computeDashboardItems

@Factory(value="currentUserTasks",
         scope=EVENT)
public Collection<DashBoardItem> computeDashboardItems()
                                                throws ClientException

Description copied from interface: DashboardActions

Computes dashboard items.

Specified by:

computeDashboardItems in interface DashboardActions

Returns:

a collection of dashboard items.

Throws:

ClientException

See Also:

factory

computeDocumentProcessItems

@Factory(value="currentUserProcesses",
         scope=EVENT)
public Collection<DocumentProcessItem> computeDocumentProcessItems()
                                                            throws ClientException

Description copied from interface: DashboardActions

Computes the document process items.

Specified by:

computeDocumentProcessItems in interface DashboardActions

Returns:

a collection

Throws:

ClientException

See Also:

factory

invalidateDocumentProcessItems

public void invalidateDocumentProcessItems()

Description copied from interface: DashboardActions

Invalidates document process items.

Specified by:

invalidateDocumentProcessItems in interface DashboardActions

See Also:

Observer

invalidateDashboardItems

public void invalidateDashboardItems()

Description copied from interface: DashboardActions

Invalidates dashboard items.

Specified by:

invalidateDashboardItems in interface DashboardActions

See Also:

Observer

destroy

@Destroy
public void destroy()

Specified by:

destroy in interface DashboardActions

viewDashboard

public String viewDashboard()

Description copied from interface: DashboardActions

View dashboard.

Specified by:

viewDashboard in interface DashboardActions

invalidateDomainBoundInfo

@Observer(value="domainSelectionChanged",
          create=false)
public void invalidateDomainBoundInfo()
                               throws ClientException

Specified by:

invalidateDomainBoundInfo in interface DashboardActions

Throws:

ClientException

invalidateDomainResultProviders

public void invalidateDomainResultProviders()
                                     throws ClientException

Specified by:

invalidateDomainResultProviders in interface DashboardActions

Throws:

ClientException

getResultsProvider

public PagedDocumentsProvider getResultsProvider(String name,
                                        SortInfo sortInfo)
                                          throws ClientException,
                                                 ResultsProviderFarmUserException

Specified by:

getResultsProvider in interface ResultsProviderFarm

Parameters:

name - the name of the ResultsProvider instance to create

sortInfo - an object containing the sort details

Throws:

ClientException

ResultsProviderFarmUserException

getResultsProvider

public PagedDocumentsProvider getResultsProvider(String name)
                                          throws ClientException,
                                                 ResultsProviderFarmUserException

Description copied from interface: ResultsProviderFarm

Makes a new, fresh instance of the named results provider.

Specified by:

getResultsProvider in interface ResultsProviderFarm

Parameters:

name - the name of the ResultsProvider instance to create

Returns:

a PagedDocumentsProvider

Throws:

ClientException

ResultsProviderFarmUserException

navigateToDocumentTab

public String navigateToDocumentTab(DocumentModel dm)
                             throws ClientException

Description copied from interface: DashboardActions

Navigates to the a given tab.

Specified by:

navigateToDocumentTab in interface DashboardActions

Parameters:

dm - document model

Returns:

a navigation id.

Throws:

ClientException

getLastModifiedDocuments

public DocumentModelList getLastModifiedDocuments()
                                           throws ClientException

Description copied from interface: DashboardActions

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

Specified by:

getLastModifiedDocuments in interface DashboardActions

Returns:

XXX

Throws:

ClientException

getUserDocuments

public DocumentModelList getUserDocuments()

Description copied from interface: DashboardActions

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

Specified by:

getUserDocuments in interface DashboardActions

getUserWorkspaces

public DocumentModelList getUserWorkspaces()

Description copied from interface: DashboardActions

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

Specified by:

getUserWorkspaces in interface DashboardActions

refreshDashboardItems

public String refreshDashboardItems()

Specified by:

refreshDashboardItems in interface DashboardActions

refreshDocumentProcessItems

public String refreshDocumentProcessItems()

Specified by:

refreshDocumentProcessItems in interface DashboardActions

refreshProvider

public String refreshProvider(String providerName)

doSearch

public String doSearch()

Specified by:

doSearch in interface DashboardActions

getSortInfo

public SortInfo getSortInfo()

Specified by:

getSortInfo in interface DashboardActions

getSelectedDomain

public DocumentModel getSelectedDomain()
                                throws ClientException

Specified by:

getSelectedDomain in interface DashboardActions

Throws:

ClientException

getAvailableDomains

@Factory(value="availableDomains",
         scope=EVENT)
public List<DocumentModel> getAvailableDomains()
                                        throws ClientException

Specified by:

getAvailableDomains in interface DashboardActions

Throws:

ClientException

invalidateAvailableDomains

@Observer(value={"documentChanged","documentSecurityChanged","documentChildrenChanged"},
          create=false)
public void invalidateAvailableDomains()
                                throws ClientException

Specified by:

invalidateAvailableDomains in interface DashboardActions

Throws:

ClientException

getSelectedDomainId

public String getSelectedDomainId()
                           throws ClientException

Specified by:

getSelectedDomainId in interface DashboardActions

Throws:

ClientException

setSelectedDomainId

public void setSelectedDomainId(String selectedDomainId)
                         throws ClientException

Specified by:

setSelectedDomainId in interface DashboardActions

Throws:

ClientException

submitSelectedDomainChange

public String submitSelectedDomainChange()
                                  throws ClientException

Specified by:

submitSelectedDomainChange in interface DashboardActions

Throws:

ClientException