Package com.logicaldoc.enterprise.webservice.soap

Interface TaskService

All Known Implementing Classes:
SoapTaskClient, SoapTaskService
public interface TaskService
This webservice allows the administrators of the default tenant to interact with the tasks.
Since:
7.1.1
Author:
Marco Meschieri - LogicalDOC

  • Method Details

    • listTasks

      List<WSTask> listTasks(String sid) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Gets the list of available tasks
      Parameters:
      sid - Session identifier
      Returns:
      The list of tasks
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - error in the data layer
      AuthenticationException - the user has not been authenticated

    • getTask

      WSTask getTask(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Gets a specific task
      Parameters:
      sid - identifier of the session
      name - unique name of the task
      Returns:
      All task's metadata
      Throws:
      com.logicaldoc.webservice.WebserviceException - error in the server
      com.logicaldoc.core.PersistenceException - error in the data layer
      AuthenticationException - the user has not been authenticated

    • enable

      void enable(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Enables a task
      Parameters:
      sid - Session identifier
      name - The name of the task
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      AuthenticationException - The user has not been authenticated

    • disable

      void disable(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Disables a task
      Parameters:
      sid - Session identifier
      name - The name of the task
      Throws:
      com.logicaldoc.webservice.WebserviceException - error in the scheduling system
      com.logicaldoc.core.PersistenceException - error in the data layer
      AuthenticationException - the user has not been authenticated

    • start

      void start(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Starts the execution of a task
      Parameters:
      sid - Session identifier
      name - The name of the task
      Throws:
      com.logicaldoc.webservice.WebserviceException - error in the scheduling system
      com.logicaldoc.core.PersistenceException - error in the data layer
      AuthenticationException - the user has not been authenticated

    • stop

      void stop(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Stops the execution of a task
      Parameters:
      sid - Session identifier
      name - The name of the task
      Throws:
      com.logicaldoc.webservice.WebserviceException - error in the scheduling system
      com.logicaldoc.core.PersistenceException - error in the data layer
      AuthenticationException - the user has not been authenticated

    • getLog

      javax.activation.DataHandler getLog(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, AuthenticationException, com.logicaldoc.core.PersistenceException
      Gets the log file of a given task
      Parameters:
      sid - Session identifier
      name - The name of the task
      Returns:
      The requested logger file
      Throws:
      com.logicaldoc.webservice.WebserviceException - error trying to access the log file
      com.logicaldoc.core.PersistenceException - error in the data layer
      AuthenticationException - the user has not been authenticated