Interface SystemService
-
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
- All Known Implementing Classes:
SystemServiceImpl
@RemoteServiceRelativePath("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 - LogicalDOC
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
SystemService.Instance
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
confirmUpdate()
Confirms the last updateboolean
disableTask(String taskName)
Disables the taskboolean
enableTask(String taskName)
Enables the taskGUIValue[]
getPlugins()
Retrieves all plug-insGUIParameter[][]
getStatistics(String locale)
Retrieves all the statistics parameters.GUITask
getTaskByName(String taskName, String locale)
Retrieves a specific task by its nameGUITask[]
loadTasks(String locale)
Retrieves all tasks.void
restart()
Restarts the applicationGUITask
saveTask(GUITask task, String locale)
Saves the taskGUIHistory[]
search(String userName, Date from, Date till, int maxResult, String historySid, String[] event, Long rootFolderId)
void
setGUILanguageStatus(String language, boolean active)
Changes the activation status of a languageboolean
startTask(String taskName)
Starts the task execution.boolean
stopTask(String taskName)
Stops the task execution.
-
-
-
Method Detail
-
getStatistics
GUIParameter[][] getStatistics(String locale) throws ServerException
Retrieves all the statistics parameters.- The first array is the Repository statistics.
- The second array is the Documents statistics.
- The third array is the Folders statistics.
- The fourth array contains the last run date.
- Parameters:
locale
- The current user locale- Returns:
- the statistics
- Throws:
ServerException
- an error happened in the server application
-
search
GUIHistory[] search(String userName, Date from, Date till, int maxResult, String historySid, String[] event, Long rootFolderId) throws ServerException
- Throws:
ServerException
-
loadTasks
GUITask[] loadTasks(String locale) throws ServerException
Retrieves all tasks.- Parameters:
locale
- The current user locale- Returns:
- the tasks
- Throws:
ServerException
- an error happened in the server application
-
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 taskName, String locale) throws ServerException
Retrieves a specific task by its name- Parameters:
taskName
- The task namelocale
- The current user locale- Returns:
- the task retrieved by the server application
- Throws:
ServerException
- an error happened in the server application
-
enableTask
boolean enableTask(String taskName) throws ServerException
Enables the task- Parameters:
taskName
- The task name- Returns:
- True, if the task is correctly enabled
- Throws:
ServerException
- an error happened in the server applications
-
disableTask
boolean disableTask(String taskName) throws ServerException
Disables the task- Parameters:
taskName
- The task name- Returns:
- True, if the task is correctly disabled
- Throws:
ServerException
- error in the server application
-
saveTask
GUITask saveTask(GUITask task, String locale) throws ServerException
Saves the task- Parameters:
task
- The task to savelocale
- The current user locale- Returns:
- the saved task
- Throws:
ServerException
- an error happened in the server application
-
setGUILanguageStatus
void setGUILanguageStatus(String language, boolean active) throws ServerException
Changes the activation status of a language- Parameters:
language
- the language to alteractive
- the new language's status- Throws:
ServerException
- an error happened in the server application
-
getPlugins
GUIValue[] getPlugins() throws ServerException
Retrieves all plug-ins- Returns:
- the installed plug-ins names
- Throws:
ServerException
- an error happened in the server application
-
confirmUpdate
void confirmUpdate() throws ServerException
Confirms the last update- Throws:
ServerException
- an error happened in the server application
-
restart
void restart() throws ServerException
Restarts the application- Throws:
ServerException
- an error happened in the server application
-
-