Package com.logicaldoc.gui.frontend.client.services

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

  • Method Details

    • getStatistics

      GUIParameter[][] getStatistics(String locale) throws ServerException
      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:
      locale - The current user locale
      Returns:
      the statistics
      Throws:
      ServerException - an error happened in the server application

    • 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 name
      locale - 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 save
      locale - The current user locale
      Returns:
      the saved task
      Throws:
      ServerException - an error happened in the server application

    • unscheduleJobs

      void unscheduleJobs(GUIValue[] jobs) throws ServerException
      Unschedules a selection of jobs
      Parameters:
      jobs - Identifiers of the jobs to delete(pairs group - trigger)
      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 alter
      active - 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

    • initializePlugin

      void initializePlugin(String plugin) throws ServerException
      Launches the initialization of a plugin
      Parameters:
      plugin - the name of the plugin to initialize
      Throws:
      ServerException - an error happened in the server application

    • installPlugin

      void installPlugin() throws ServerException
      Installs the uploaded plugin package
      Throws:
      ServerException - error happened in the server application

    • uninstallPlugin

      void uninstallPlugin(String plugin) throws ServerException
      Uninstalls the given plugin
      Parameters:
      plugin - identifier of the plugin to uninstall
      Throws:
      ServerException - 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

    • search

      GUIHistory[] search(Long userId, Date from, Date till, int maxResult, String historySid, String[] event, Long rootFolderId) throws ServerException
      Throws:
      ServerException

    • searchApiCalls

      GUIHistory[] searchApiCalls(Long userId, Date from, Date till, String callSid, String protocol, String uri, int maxResult) throws ServerException
      Throws:
      ServerException