com.logicaldoc.gui.frontend.client.services

Interface SystemService

All Superinterfaces:

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

All Known Implementing Classes:

SystemServiceImpl

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

The client side stub for the System Service. This service allows the management of various system settings.

Since:

6.0

Author:

Matteo Caruso - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFeedMessages(String sid, long[] ids) Deletes a list of Feed Messages
boolean	disableTask(String sid, String taskName) Disables the task.
boolean	enableTask(String sid, String taskName) Enables the task.
GUIValuePair[]	getPlugins(String sid) Retrieves all plugins.
GUIParameter[][]	getStatistics(String sid, String locale) Retrieves all the statistics parameters.
GUITask	getTaskByName(String sid, String taskName, String locale) Retrieves a specific task by its name
GUITask[]	loadTasks(String sid, String locale) Retrieves all tasks.
void	markFeedMsgAsNotRead(String sid, long[] ids) Marks as not read a list of Feed Messages
void	markFeedMsgAsRead(String sid, long[] ids) Marks as read a list of Feed Messages
GUITask	saveTask(String sid, GUITask task, String locale) Saves the task.
GUIHistory[]	search(String sid, String userName, Date from, Date till, int maxResult, String historySid, String[] event) Performs a search over the last changes.
void	setGUILanguageStatus(String sid, String language, boolean active) Changes the activation status of a language
boolean	startTask(String taskName) Starts the task execution.
boolean	stopTask(String taskName) Stops the task execution.

Method Detail

getStatistics

GUIParameter[][] getStatistics(String sid,
                             String locale)
                               throws InvalidSessionException

Retrieves all the statistics parameters.

1. The first array is the Repository statistics.
2. The second array is the Documents statistics.
3. The third array is the Folders statistics.
4. The fourth array contains the last run date.

Parameters:

sid - The current user session

locale - The current user locale

Throws:

InvalidSessionException

search

GUIHistory[] search(String sid,
                  String userName,
                  Date from,
                  Date till,
                  int maxResult,
                  String historySid,
                  String[] event)
                    throws InvalidSessionException

Performs a search over the last changes.

Parameters:

sid - The current user session

username - The user name that must be associated to the history

from - The starting date to search the histories

till - The ending date to search the histories

maxResult - The maximum number of history results

historySid - The history session identifier

event - The history events

Returns:

Result hits and statistics

Throws:

InvalidSessionException

loadTasks

GUITask[] loadTasks(String sid,
                  String locale)
                    throws InvalidSessionException

Retrieves all tasks.

Parameters:

sid - The current user session

locale - The current user locale

Throws:

InvalidSessionException

startTask

boolean startTask(String taskName)

Starts the task execution.

Parameters:

taskName - The task name

Returns:

True, if the task is correctly started.

stopTask

boolean stopTask(String taskName)

Stops the task execution.

Parameters:

taskName - The task name

Returns:

True, if the task is correctly stopped.

getTaskByName

GUITask getTaskByName(String sid,
                    String taskName,
                    String locale)
                      throws InvalidSessionException

Retrieves a specific task by its name

Parameters:

sid - The current user session

taskName - The task name

locale - The current user locale

Throws:

InvalidSessionException

enableTask

boolean enableTask(String sid,
                 String taskName)
                   throws InvalidSessionException

Enables the task.

Parameters:

sid - The current user session

taskName - The task name

Returns:

True, if the task is correctly enabled.

Throws:

InvalidSessionException

disableTask

boolean disableTask(String sid,
                  String taskName)
                    throws InvalidSessionException

Disables the task.

Parameters:

sid - The current user session

taskName - The task name

Returns:

True, if the task is correctly disabled.

Throws:

InvalidSessionException

saveTask

GUITask saveTask(String sid,
               GUITask task,
               String locale)
                 throws InvalidSessionException

Saves the task.

Parameters:

sid - The current user session

task - The task to be saved

locale - The current user locale

Returns:

True, if the task is correctly saved.

Throws:

InvalidSessionException

setGUILanguageStatus

void setGUILanguageStatus(String sid,
                        String language,
                        boolean active)
                          throws InvalidSessionException

Changes the activation status of a language

Throws:

InvalidSessionException

markFeedMsgAsRead

void markFeedMsgAsRead(String sid,
                     long[] ids)
                       throws InvalidSessionException

Marks as read a list of Feed Messages

Throws:

InvalidSessionException

markFeedMsgAsNotRead

void markFeedMsgAsNotRead(String sid,
                        long[] ids)
                          throws InvalidSessionException

Marks as not read a list of Feed Messages

Throws:

InvalidSessionException

deleteFeedMessages

void deleteFeedMessages(String sid,
                      long[] ids)
                        throws InvalidSessionException

Deletes a list of Feed Messages

Throws:

InvalidSessionException

getPlugins

GUIValuePair[] getPlugins(String sid)
                          throws InvalidSessionException

Retrieves all plugins.

Parameters:

sid - The current user session

Throws:

InvalidSessionException