com.openkm.api

Class OKMDashboard

java.lang.Object

com.openkm.api.OKMDashboard

All Implemented Interfaces:

DashboardModule

public class OKMDashboard
extends Object
implements DashboardModule

Author:

pavila

Method Summary

Modifier and Type	Method and Description
List<DashboardDocumentResult>	find(String token, int qpId) Find
static OKMDashboard	getInstance()
List<DashboardDocumentResult>	getLastModifiedDocuments(String token) Get last modified documents
List<DashboardDocumentResult>	getLastMonthTopDownloadedDocuments(String token) Get last month downloaded documents
List<DashboardDocumentResult>	getLastMonthTopModifiedDocuments(String token) Get las month top modified documentd
List<DashboardDocumentResult>	getLastUploadedDocuments(String token) Get last uploaded documents
List<DashboardDocumentResult>	getLastWeekTopDownloadedDocuments(String token) Get last week top downloaded documents
List<DashboardDocumentResult>	getLastWeekTopModifiedDocuments(String token) Get last week top modified documents
List<DashboardDocumentResult>	getUserCheckedOutDocuments(String token) Get list of checked-out documents by user
long	getUserDocumentsSize(String token) Get user documents size
List<DashboardDocumentResult>	getUserLastDownloadedDocuments(String token) Get user last downloaded documents
List<DashboardDocumentResult>	getUserLastImportedMailAttachments(String token) Get user last imported mail attachments
List<DashboardMailResult>	getUserLastImportedMails(String token) Get user last imported mails
List<DashboardDocumentResult>	getUserLastModifiedDocuments(String token) Get user last modified documents
List<DashboardDocumentResult>	getUserLastUploadedDocuments(String token) Get user last uploaded documents
List<DashboardDocumentResult>	getUserLockedDocuments(String token) Get list of locked documents by user
List<QueryParams>	getUserSearchs(String token) Get user searchs
List<DashboardDocumentResult>	getUserSubscribedDocuments(String token) Get user subscribed documents
List<DashboardFolderResult>	getUserSubscribedFolders(String token) Get user subscribed folders
void	visiteNode(String token, String source, String node, Calendar date) Visite node

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMDashboard getInstance()

getUserCheckedOutDocuments

public List<DashboardDocumentResult> getUserCheckedOutDocuments(String token)
                                                         throws AccessDeniedException,
                                                                RepositoryException,
                                                                DatabaseException

Description copied from interface: DashboardModule

Get list of checked-out documents by user

Specified by:

getUserCheckedOutDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserLastModifiedDocuments

public List<DashboardDocumentResult> getUserLastModifiedDocuments(String token)
                                                           throws AccessDeniedException,
                                                                  RepositoryException,
                                                                  DatabaseException

Description copied from interface: DashboardModule

Get user last modified documents

Specified by:

getUserLastModifiedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserLockedDocuments

public List<DashboardDocumentResult> getUserLockedDocuments(String token)
                                                     throws AccessDeniedException,
                                                            RepositoryException,
                                                            DatabaseException

Description copied from interface: DashboardModule

Get list of locked documents by user

Specified by:

getUserLockedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserSubscribedDocuments

public List<DashboardDocumentResult> getUserSubscribedDocuments(String token)
                                                         throws AccessDeniedException,
                                                                RepositoryException,
                                                                DatabaseException

Description copied from interface: DashboardModule

Get user subscribed documents

Specified by:

getUserSubscribedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserSubscribedFolders

public List<DashboardFolderResult> getUserSubscribedFolders(String token)
                                                     throws AccessDeniedException,
                                                            RepositoryException,
                                                            DatabaseException

Description copied from interface: DashboardModule

Get user subscribed folders

Specified by:

getUserSubscribedFolders in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserLastUploadedDocuments

public List<DashboardDocumentResult> getUserLastUploadedDocuments(String token)
                                                           throws AccessDeniedException,
                                                                  RepositoryException,
                                                                  DatabaseException

Description copied from interface: DashboardModule

Get user last uploaded documents

Specified by:

getUserLastUploadedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserLastDownloadedDocuments

public List<DashboardDocumentResult> getUserLastDownloadedDocuments(String token)
                                                             throws AccessDeniedException,
                                                                    RepositoryException,
                                                                    DatabaseException

Description copied from interface: DashboardModule

Get user last downloaded documents

Specified by:

getUserLastDownloadedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserLastImportedMails

public List<DashboardMailResult> getUserLastImportedMails(String token)
                                                   throws AccessDeniedException,
                                                          RepositoryException,
                                                          DatabaseException

Description copied from interface: DashboardModule

Get user last imported mails

Specified by:

getUserLastImportedMails in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserLastImportedMailAttachments

public List<DashboardDocumentResult> getUserLastImportedMailAttachments(String token)
                                                                 throws AccessDeniedException,
                                                                        RepositoryException,
                                                                        DatabaseException

Description copied from interface: DashboardModule

Get user last imported mail attachments

Specified by:

getUserLastImportedMailAttachments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserDocumentsSize

public long getUserDocumentsSize(String token)
                          throws AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException

Description copied from interface: DashboardModule

Get user documents size

Specified by:

getUserDocumentsSize in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getUserSearchs

public List<QueryParams> getUserSearchs(String token)
                                 throws AccessDeniedException,
                                        RepositoryException,
                                        DatabaseException

Description copied from interface: DashboardModule

Get user searchs

Specified by:

getUserSearchs in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

find

public List<DashboardDocumentResult> find(String token,
                                          int qpId)
                                   throws IOException,
                                          ParseException,
                                          AccessDeniedException,
                                          RepositoryException,
                                          DatabaseException

Description copied from interface: DashboardModule

Find

Specified by:

find in interface DashboardModule

Throws:

IOException

ParseException

AccessDeniedException

RepositoryException

DatabaseException

getLastWeekTopDownloadedDocuments

public List<DashboardDocumentResult> getLastWeekTopDownloadedDocuments(String token)
                                                                throws AccessDeniedException,
                                                                       RepositoryException,
                                                                       DatabaseException

Description copied from interface: DashboardModule

Get last week top downloaded documents

Specified by:

getLastWeekTopDownloadedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getLastMonthTopDownloadedDocuments

public List<DashboardDocumentResult> getLastMonthTopDownloadedDocuments(String token)
                                                                 throws AccessDeniedException,
                                                                        RepositoryException,
                                                                        DatabaseException

Description copied from interface: DashboardModule

Get last month downloaded documents

Specified by:

getLastMonthTopDownloadedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getLastWeekTopModifiedDocuments

public List<DashboardDocumentResult> getLastWeekTopModifiedDocuments(String token)
                                                              throws AccessDeniedException,
                                                                     RepositoryException,
                                                                     DatabaseException

Description copied from interface: DashboardModule

Get last week top modified documents

Specified by:

getLastWeekTopModifiedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getLastMonthTopModifiedDocuments

public List<DashboardDocumentResult> getLastMonthTopModifiedDocuments(String token)
                                                               throws AccessDeniedException,
                                                                      RepositoryException,
                                                                      DatabaseException

Description copied from interface: DashboardModule

Get las month top modified documentd

Specified by:

getLastMonthTopModifiedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getLastModifiedDocuments

public List<DashboardDocumentResult> getLastModifiedDocuments(String token)
                                                       throws AccessDeniedException,
                                                              RepositoryException,
                                                              DatabaseException

Description copied from interface: DashboardModule

Get last modified documents

Specified by:

getLastModifiedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

getLastUploadedDocuments

public List<DashboardDocumentResult> getLastUploadedDocuments(String token)
                                                       throws AccessDeniedException,
                                                              RepositoryException,
                                                              DatabaseException

Description copied from interface: DashboardModule

Get last uploaded documents

Specified by:

getLastUploadedDocuments in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

visiteNode

public void visiteNode(String token,
                       String source,
                       String node,
                       Calendar date)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: DashboardModule

Visite node

Specified by:

visiteNode in interface DashboardModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException