com.openkm.sdk4j.definition

Interface BaseRepository

All Known Implementing Classes:

OKMWebservices, RepositoryImpl

public interface BaseRepository

BaseRepository

Author:

jllort

Method Summary

Modifier and Type	Method and Description
void	copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes) Copy attributes.
void	copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki) Copy attributes.
HqlQueryResults	executeHqlQuery(InputStream is) Execute hql query hql query results.
HqlQueryResults	executeHqlQuery(String hql) Execute hql query hql query results.
ScriptExecutionResult	executeScript(InputStream is) Execute script script execution result.
ScriptExecutionResult	executeScript(String script) Execute script script execution result.
SqlQueryResults	executeSqlQuery(InputStream is) Execute sql query sql query results.
SqlQueryResults	executeSqlQuery(String sql) Execute sql query sql query results.
AppVersion	getAppVersion() Gets app version.
Map<String,String>	getAvailableLocales(String locale) Gets available locales.
Folder	getCategoriesFolder() Gets categories folder.
List<ChangeLogged>	getChangeLog(String nodePath, Calendar modificationsFrom) Gets change log.
String	getClusterUuid() Gets cluster uuid.
Configuration	getConfiguration(String key) Gets configuration.
boolean	getIsFilePlan() Gets is file plan.
LicenseInfo	getLicenseInfo() Gets license info.
Folder	getMailFolder() Gets mail folder.
Folder	getMailFolderBase() Gets mail folder base.
String	getNodePath(String uuid) Gets node path.
String	getNodeUuid(String nodePath) Gets node uuid.
Folder	getPersonalFolder() Gets personal folder.
Folder	getPersonalFolderBase() Gets personal folder base.
String	getRepositoryUuid() Gets repository uuid.
Folder	getRootFolder() Gets root folder.
String	getServerTime() Gets server time.
Folder	getTemplatesFolder() Gets templates folder.
Folder	getThesaurusFolder() Gets thesaurus folder.
Map<String,String>	getTranslations(String lang, String module) Gets translations.
Folder	getTrashFolder() Gets trash folder.
Folder	getTrashFolderBase() Gets trash folder base.
String	getUpdateMessage() Gets update message.
boolean	hasNode(String nodeId) Has node boolean.
void	purgeTrash() Purge trash.

Method Detail

getRootFolder

Folder getRootFolder()
              throws AccessDeniedException,
                     PathNotFoundException,
                     RepositoryException,
                     DatabaseException,
                     UnknownException,
                     WebserviceException

Gets root folder.

Returns:

the root folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getTrashFolder

Folder getTrashFolder()
               throws AccessDeniedException,
                      PathNotFoundException,
                      RepositoryException,
                      DatabaseException,
                      UnknownException,
                      WebserviceException

Gets trash folder.

Returns:

the trash folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getTrashFolderBase

Folder getTrashFolderBase()
                   throws AccessDeniedException,
                          PathNotFoundException,
                          RepositoryException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException

Gets trash folder base.

Returns:

the trash folder base

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getTemplatesFolder

Folder getTemplatesFolder()
                   throws AccessDeniedException,
                          PathNotFoundException,
                          RepositoryException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException

Gets templates folder.

Returns:

the templates folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPersonalFolder

Folder getPersonalFolder()
                  throws AccessDeniedException,
                         PathNotFoundException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Gets personal folder.

Returns:

the personal folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPersonalFolderBase

Folder getPersonalFolderBase()
                      throws AccessDeniedException,
                             PathNotFoundException,
                             RepositoryException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException

Gets personal folder base.

Returns:

the personal folder base

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getMailFolder

Folder getMailFolder()
              throws AccessDeniedException,
                     PathNotFoundException,
                     RepositoryException,
                     DatabaseException,
                     UnknownException,
                     WebserviceException

Gets mail folder.

Returns:

the mail folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getMailFolderBase

Folder getMailFolderBase()
                  throws AccessDeniedException,
                         PathNotFoundException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Gets mail folder base.

Returns:

the mail folder base

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getThesaurusFolder

Folder getThesaurusFolder()
                   throws AccessDeniedException,
                          PathNotFoundException,
                          RepositoryException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException

Gets thesaurus folder.

Returns:

the thesaurus folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getCategoriesFolder

Folder getCategoriesFolder()
                    throws AccessDeniedException,
                           PathNotFoundException,
                           RepositoryException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException

Gets categories folder.

Returns:

the categories folder

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

purgeTrash

void purgeTrash()
         throws PathNotFoundException,
                AccessDeniedException,
                LockException,
                RepositoryException,
                DatabaseException,
                PromotedAsRecordLockException,
                UnknownException,
                WebserviceException

Purge trash.

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

LockException - the lock exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getUpdateMessage

String getUpdateMessage()
                 throws AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        UnknownException,
                        WebserviceException

Gets update message.

Returns:

the update message

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRepositoryUuid

String getRepositoryUuid()
                  throws AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Gets repository uuid.

Returns:

the repository uuid

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

hasNode

boolean hasNode(String nodeId)
         throws AccessDeniedException,
                RepositoryException,
                DatabaseException,
                UnknownException,
                WebserviceException

Has node boolean.

Parameters:

nodeId - the node id

Returns:

the boolean

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getNodePath

String getNodePath(String uuid)
            throws AccessDeniedException,
                   PathNotFoundException,
                   RepositoryException,
                   DatabaseException,
                   UnknownException,
                   WebserviceException

Gets node path.

Parameters:

uuid - the uuid

Returns:

the node path

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getNodeUuid

String getNodeUuid(String nodePath)
            throws AccessDeniedException,
                   PathNotFoundException,
                   RepositoryException,
                   DatabaseException,
                   UnknownException,
                   WebserviceException

Gets node uuid.

Parameters:

nodePath - the node path

Returns:

the node uuid

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAppVersion

AppVersion getAppVersion()
                  throws AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Gets app version.

Returns:

the app version

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copyAttributes

void copyAttributes(String uuid,
                    String dstId,
                    boolean categories,
                    boolean keywords,
                    boolean propertyGroups,
                    boolean notes)
             throws ItemExistsException,
                    PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    UserQuotaExceededException,
                    AutomationException,
                    PromotedAsRecordLockException,
                    UnknownException,
                    WebserviceException

Copy attributes.

Parameters:

uuid - the uuid

dstId - the dst id

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copyAttributes

void copyAttributes(String uuid,
                    String dstId,
                    boolean categories,
                    boolean keywords,
                    boolean propertyGroups,
                    boolean notes,
                    boolean wiki)
             throws ItemExistsException,
                    PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    UserQuotaExceededException,
                    AutomationException,
                    PromotedAsRecordLockException,
                    UnknownException,
                    WebserviceException

Copy attributes.

Parameters:

uuid - the uuid

dstId - the dst id

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

wiki - the wiki

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

executeScript

ScriptExecutionResult executeScript(InputStream is)
                             throws AccessDeniedException,
                                    UnknownException,
                                    WebserviceException

Execute script script execution result.

Parameters:

is - the is

Returns:

the script execution result

Throws:

AccessDeniedException - the access denied exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

executeScript

ScriptExecutionResult executeScript(String script)
                             throws AccessDeniedException,
                                    UnknownException,
                                    WebserviceException,
                                    IOException

Execute script script execution result.

Parameters:

script - the script

Returns:

the script execution result

Throws:

AccessDeniedException - the access denied exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

executeSqlQuery

SqlQueryResults executeSqlQuery(InputStream is)
                         throws AccessDeniedException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException

Execute sql query sql query results.

Parameters:

is - the is

Returns:

the sql query results

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

executeSqlQuery

SqlQueryResults executeSqlQuery(String sql)
                         throws AccessDeniedException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException,
                                IOException

Execute sql query sql query results.

Parameters:

sql - the sql

Returns:

the sql query results

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

executeHqlQuery

HqlQueryResults executeHqlQuery(InputStream is)
                         throws AccessDeniedException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException

Execute hql query hql query results.

Parameters:

is - the is

Returns:

the hql query results

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

executeHqlQuery

HqlQueryResults executeHqlQuery(String hql)
                         throws AccessDeniedException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException,
                                IOException

Execute hql query hql query results.

Parameters:

hql - the hql

Returns:

the hql query results

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

getTranslations

Map<String,String> getTranslations(String lang,
                                   String module)
                            throws AccessDeniedException,
                                   DatabaseException,
                                   UnknownException,
                                   WebserviceException

Gets translations.

Parameters:

lang - the lang

module - the module

Returns:

the translations

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getConfiguration

Configuration getConfiguration(String key)
                        throws DatabaseException,
                               UnknownException,
                               WebserviceException

Gets configuration.

Parameters:

key - the key

Returns:

the configuration

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getChangeLog

List<ChangeLogged> getChangeLog(String nodePath,
                                Calendar modificationsFrom)
                         throws AccessDeniedException,
                                DatabaseException,
                                PathNotFoundException,
                                UnknownException,
                                WebserviceException

Gets change log.

Parameters:

nodePath - the node path

modificationsFrom - the modifications from

Returns:

the change log

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAvailableLocales

Map<String,String> getAvailableLocales(String locale)
                                throws WebserviceException,
                                       PathNotFoundException,
                                       ParseException,
                                       RepositoryException,
                                       DatabaseException,
                                       UnknownException,
                                       AccessDeniedException

Gets available locales.

Parameters:

locale - the locale

Returns:

the available locales

Throws:

WebserviceException - the webservice exception

PathNotFoundException - the path not found exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

AccessDeniedException - the access denied exception

getServerTime

String getServerTime()
              throws UnknownException,
                     WebserviceException

Gets server time.

Returns:

the server time

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

getLicenseInfo

LicenseInfo getLicenseInfo()
                    throws WebserviceException,
                           RepositoryException,
                           UnknownException,
                           AccessDeniedException

Gets license info.

Returns:

the license info

Throws:

WebserviceException - the webservice exception

RepositoryException - the repository exception

UnknownException - the unknown exception

AccessDeniedException - the access denied exception

getClusterUuid

String getClusterUuid()
               throws WebserviceException,
                      RepositoryException,
                      UnknownException

Gets cluster uuid.

Returns:

the cluster uuid

Throws:

WebserviceException - the webservice exception

RepositoryException - the repository exception

UnknownException - the unknown exception

getIsFilePlan

boolean getIsFilePlan()
               throws WebserviceException,
                      RepositoryException,
                      UnknownException

Gets is file plan.

Returns:

the is file plan

Throws:

WebserviceException - the webservice exception

RepositoryException - the repository exception

UnknownException - the unknown exception