com.openkm.sdk4j.definition

Interface BaseDashboard

All Known Implementing Classes:

DashboardImpl

public interface BaseDashboard

The interface Base dashboard.

Method Summary

Modifier and Type	Method and Description
List<DashboardNodeResult>	findUserSearches(long ncId) Find user searches list.
DashboardResultSet	getUserCheckedOutDocuments(int offset, int limit) Gets user checked out documents.
DashboardResultSet	getUserLastCreatedDocuments(int offset, int limit) Gets user last created documents.
DashboardResultSet	getUserLastCreatedFolders(int offset, int limit) Gets user last created folders.
DashboardResultSet	getUserLastCreatedRecords(int offset, int limit) Gets user last created records.
DashboardResultSet	getUserLastDocumentsNotesCreated(int offset, int limit) Gets user last documents notes created.
DashboardResultSet	getUserLastDownloadedDocuments(int offset, int limit) Gets user last downloaded documents.
DashboardResultSet	getUserLastFoldersNotesCreated(int offset, int limit) Gets user last folders notes created.
DashboardResultSet	getUserLastImportedMailAttachments(int offset, int limit) Gets user last imported mail attachments.
DashboardResultSet	getUserLastImportedMails(int offset, int limit) Gets user last imported mails.
DashboardResultSet	getUserLastMailsNotesCreated(int offset, int limit) Gets user last mails notes created.
DashboardResultSet	getUserLastModifiedDocuments(int offset, int limit) Gets user last modified documents.
DashboardResultSet	getUserLastRecordsNotesCreated(int offset, int limit) Gets user last records notes created.
DashboardResultSet	getUserLockedDocuments(int offset, int limit) Gets user locked documents.
DashboardResultSet	getUserLockedFolders(int offset, int limit) Gets user locked folders.
DashboardResultSet	getUserLockedMails(int offset, int limit) Gets user locked mails.
DashboardResultSet	getUserLockedRecords(int offset, int limit) Gets user locked records.
List<QueryParams>	getUserSearches() Gets user searches.
DashboardResultSet	getUserSubscribedDocuments(int offset, int limit) Gets user subscribed documents.
DashboardResultSet	getUserSubscribedFolders(int offset, int limit) Gets user subscribed folders.
DashboardResultSet	getUserSubscribedRecords(int offset, int limit) Gets user subscribed records.

Method Detail

getUserCheckedOutDocuments

DashboardResultSet getUserCheckedOutDocuments(int offset,
                                              int limit)
                                       throws RepositoryException,
                                              PathNotFoundException,
                                              DatabaseException,
                                              AccessDeniedException,
                                              WebserviceException,
                                              UnknownException

Gets user checked out documents.

Parameters:

offset - the offset

limit - the limit

Returns:

the user checked out documents

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastModifiedDocuments

DashboardResultSet getUserLastModifiedDocuments(int offset,
                                                int limit)
                                         throws RepositoryException,
                                                PathNotFoundException,
                                                DatabaseException,
                                                AccessDeniedException,
                                                WebserviceException,
                                                UnknownException

Gets user last modified documents.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last modified documents

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLockedDocuments

DashboardResultSet getUserLockedDocuments(int offset,
                                          int limit)
                                   throws RepositoryException,
                                          PathNotFoundException,
                                          DatabaseException,
                                          AccessDeniedException,
                                          WebserviceException,
                                          UnknownException

Gets user locked documents.

Parameters:

offset - the offset

limit - the limit

Returns:

the user locked documents

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLockedRecords

DashboardResultSet getUserLockedRecords(int offset,
                                        int limit)
                                 throws RepositoryException,
                                        PathNotFoundException,
                                        DatabaseException,
                                        AccessDeniedException,
                                        WebserviceException,
                                        UnknownException

Gets user locked records.

Parameters:

offset - the offset

limit - the limit

Returns:

the user locked records

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLockedFolders

DashboardResultSet getUserLockedFolders(int offset,
                                        int limit)
                                 throws RepositoryException,
                                        PathNotFoundException,
                                        DatabaseException,
                                        AccessDeniedException,
                                        WebserviceException,
                                        UnknownException

Gets user locked folders.

Parameters:

offset - the offset

limit - the limit

Returns:

the user locked folders

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLockedMails

DashboardResultSet getUserLockedMails(int offset,
                                      int limit)
                               throws RepositoryException,
                                      PathNotFoundException,
                                      DatabaseException,
                                      AccessDeniedException,
                                      WebserviceException,
                                      UnknownException

Gets user locked mails.

Parameters:

offset - the offset

limit - the limit

Returns:

the user locked mails

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserSubscribedDocuments

DashboardResultSet getUserSubscribedDocuments(int offset,
                                              int limit)
                                       throws RepositoryException,
                                              PathNotFoundException,
                                              DatabaseException,
                                              AccessDeniedException,
                                              WebserviceException,
                                              UnknownException

Gets user subscribed documents.

Parameters:

offset - the offset

limit - the limit

Returns:

the user subscribed documents

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserSubscribedFolders

DashboardResultSet getUserSubscribedFolders(int offset,
                                            int limit)
                                     throws RepositoryException,
                                            PathNotFoundException,
                                            DatabaseException,
                                            AccessDeniedException,
                                            WebserviceException,
                                            UnknownException

Gets user subscribed folders.

Parameters:

offset - the offset

limit - the limit

Returns:

the user subscribed folders

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserSubscribedRecords

DashboardResultSet getUserSubscribedRecords(int offset,
                                            int limit)
                                     throws RepositoryException,
                                            PathNotFoundException,
                                            DatabaseException,
                                            AccessDeniedException,
                                            WebserviceException,
                                            UnknownException

Gets user subscribed records.

Parameters:

offset - the offset

limit - the limit

Returns:

the user subscribed records

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastCreatedDocuments

DashboardResultSet getUserLastCreatedDocuments(int offset,
                                               int limit)
                                        throws RepositoryException,
                                               PathNotFoundException,
                                               DatabaseException,
                                               AccessDeniedException,
                                               WebserviceException,
                                               UnknownException

Gets user last created documents.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last created documents

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastDocumentsNotesCreated

DashboardResultSet getUserLastDocumentsNotesCreated(int offset,
                                                    int limit)
                                             throws RepositoryException,
                                                    PathNotFoundException,
                                                    DatabaseException,
                                                    AccessDeniedException,
                                                    WebserviceException,
                                                    UnknownException

Gets user last documents notes created.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last documents notes created

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastCreatedFolders

DashboardResultSet getUserLastCreatedFolders(int offset,
                                             int limit)
                                      throws RepositoryException,
                                             PathNotFoundException,
                                             DatabaseException,
                                             AccessDeniedException,
                                             WebserviceException,
                                             UnknownException

Gets user last created folders.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last created folders

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastFoldersNotesCreated

DashboardResultSet getUserLastFoldersNotesCreated(int offset,
                                                  int limit)
                                           throws RepositoryException,
                                                  PathNotFoundException,
                                                  DatabaseException,
                                                  AccessDeniedException,
                                                  WebserviceException,
                                                  UnknownException

Gets user last folders notes created.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last folders notes created

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastCreatedRecords

DashboardResultSet getUserLastCreatedRecords(int offset,
                                             int limit)
                                      throws RepositoryException,
                                             PathNotFoundException,
                                             DatabaseException,
                                             AccessDeniedException,
                                             WebserviceException,
                                             UnknownException

Gets user last created records.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last created records

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastRecordsNotesCreated

DashboardResultSet getUserLastRecordsNotesCreated(int offset,
                                                  int limit)
                                           throws RepositoryException,
                                                  PathNotFoundException,
                                                  DatabaseException,
                                                  AccessDeniedException,
                                                  WebserviceException,
                                                  UnknownException

Gets user last records notes created.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last records notes created

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastDownloadedDocuments

DashboardResultSet getUserLastDownloadedDocuments(int offset,
                                                  int limit)
                                           throws RepositoryException,
                                                  PathNotFoundException,
                                                  DatabaseException,
                                                  AccessDeniedException,
                                                  WebserviceException,
                                                  UnknownException

Gets user last downloaded documents.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last downloaded documents

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastImportedMails

DashboardResultSet getUserLastImportedMails(int offset,
                                            int limit)
                                     throws RepositoryException,
                                            PathNotFoundException,
                                            DatabaseException,
                                            AccessDeniedException,
                                            WebserviceException,
                                            UnknownException

Gets user last imported mails.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last imported mails

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastMailsNotesCreated

DashboardResultSet getUserLastMailsNotesCreated(int offset,
                                                int limit)
                                         throws RepositoryException,
                                                PathNotFoundException,
                                                DatabaseException,
                                                AccessDeniedException,
                                                WebserviceException,
                                                UnknownException

Gets user last mails notes created.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last mails notes created

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserLastImportedMailAttachments

DashboardResultSet getUserLastImportedMailAttachments(int offset,
                                                      int limit)
                                               throws RepositoryException,
                                                      PathNotFoundException,
                                                      DatabaseException,
                                                      AccessDeniedException,
                                                      WebserviceException,
                                                      UnknownException

Gets user last imported mail attachments.

Parameters:

offset - the offset

limit - the limit

Returns:

the user last imported mail attachments

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserSearches

List<QueryParams> getUserSearches()
                           throws DatabaseException,
                                  AccessDeniedException,
                                  WebserviceException,
                                  UnknownException

Gets user searches.

Returns:

the user searches

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

findUserSearches

List<DashboardNodeResult> findUserSearches(long ncId)
                                    throws RepositoryException,
                                           PathNotFoundException,
                                           DatabaseException,
                                           AccessDeniedException,
                                           WebserviceException,
                                           UnknownException,
                                           ParseException

Find user searches list.

Parameters:

ncId - the nc id

Returns:

the list

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

ParseException - the parse exception