com.logicaldoc.gui.frontend.client.services

Interface SettingService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

SettingServiceImpl

@RemoteServiceRelativePath(value="setting")
public interface SettingService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Settings Service. This service allows the management of various application settings.

Since:

6.0

Author:

Matteo Caruso - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
GUIParameter[]	computeStoragesSize(String sid) Retrieves the size of all saved storages.
GUIParameter[]	loadClientSettings(String sid) Loads web services, webDav and other client-related settings
GUIEmailSettings	loadEmailSettings(String sid) Loads email settings (SMTP connection)
GUIParameter[]	loadGUISettings(String sid) Load the GUI settings
GUIParameter[]	loadOcrSettings(String sid) Loads the OCR settings
GUIParameter[]	loadQuotaSettings(String sid) Load the system quota setting
GUIParameter[][]	loadRepositories(String sid) Load the repositories paths.
GUIParameter[]	loadSettings(String sid) Loads the complete settings set
GUIParameter[]	loadSettingsByNames(String sid, String[] names) Loads a set of settings values
void	saveDashlets(String sid, GUIDashlet[] dashlets) Saves the dashlets configuration for the current user
void	saveEmailSettings(String sid, GUIEmailSettings settings) Saves email settings (SMTP connection)
void	saveQuotaSettings(String sid, GUIParameter[] quotaSettings) Saves system quota setting
void	saveRepositories(String sid, GUIParameter[][] repos) Saves folders path
void	saveSettings(String sid, GUIParameter[] settings) Saves settings
boolean	testEmail(String sid, String email) Tests the SMTP connection

Method Detail

loadClientSettings

GUIParameter[] loadClientSettings(String sid)
                                  throws InvalidSessionException

Loads web services, webDav and other client-related settings

Throws:

InvalidSessionException

loadSettings

GUIParameter[] loadSettings(String sid)
                            throws InvalidSessionException

Loads the complete settings set

Throws:

InvalidSessionException

loadSettingsByNames

GUIParameter[] loadSettingsByNames(String sid,
                                 String[] names)
                                   throws InvalidSessionException

Loads a set of settings values

Parameters:

sid - The current session identifier

names - The setting names to be retrieved

Returns:

The array of settings

Throws:

InvalidSessionException

saveSettings

void saveSettings(String sid,
                GUIParameter[] settings)
                  throws InvalidSessionException

Saves settings

Throws:

InvalidSessionException

loadEmailSettings

GUIEmailSettings loadEmailSettings(String sid)
                                   throws InvalidSessionException

Loads email settings (SMTP connection)

Throws:

InvalidSessionException

testEmail

boolean testEmail(String sid,
                String email)
                  throws InvalidSessionException

Tests the SMTP connection

Parameters:

sid - The session identifier

email - email address to test(it will receive a test message)

Returns:

True only if the email was sent

Throws:

InvalidSessionException

loadRepositories

GUIParameter[][] loadRepositories(String sid)
                                  throws InvalidSessionException

Load the repositories paths.

1. The first array contains the folders paths.
2. The second array contains the available repositories paths.

Throws:

InvalidSessionException

saveRepositories

void saveRepositories(String sid,
                    GUIParameter[][] repos)
                      throws InvalidSessionException

Saves folders path

Throws:

InvalidSessionException

saveEmailSettings

void saveEmailSettings(String sid,
                     GUIEmailSettings settings)
                       throws InvalidSessionException

Saves email settings (SMTP connection)

Throws:

InvalidSessionException

loadOcrSettings

GUIParameter[] loadOcrSettings(String sid)
                               throws InvalidSessionException

Loads the OCR settings

Throws:

InvalidSessionException

loadQuotaSettings

GUIParameter[] loadQuotaSettings(String sid)
                                 throws InvalidSessionException

Load the system quota setting

Throws:

InvalidSessionException

loadGUISettings

GUIParameter[] loadGUISettings(String sid)
                               throws InvalidSessionException

Load the GUI settings

Throws:

InvalidSessionException

saveQuotaSettings

void saveQuotaSettings(String sid,
                     GUIParameter[] quotaSettings)
                       throws InvalidSessionException

Saves system quota setting

Throws:

InvalidSessionException

computeStoragesSize

GUIParameter[] computeStoragesSize(String sid)
                                   throws InvalidSessionException

Retrieves the size of all saved storages.

Parameters:

sid - The current user session

Throws:

InvalidSessionException

saveDashlets

void saveDashlets(String sid,
                GUIDashlet[] dashlets)
                  throws InvalidSessionException

Saves the dashlets configuration for the current user

Throws:

InvalidSessionException