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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
disable(String sid, String name)
Disables a taskvoid
enable(String sid, String name)
Enables a taskjavax.activation.DataHandler
getLog(String sid, String name)
Gets the log file of a given taskWSTask
getTask(String sid, String name)
Gets a specific taskWSTask[]
listTasks(String sid)
Gets the list of available tasksvoid
start(String sid, String name)
Starts the execution of a taskvoid
stop(String sid, String name)
Stops the execution of a task
-
-
-
Method Detail
-
listTasks
WSTask[] listTasks(String sid) throws Exception
Gets the list of available tasks- Parameters:
sid
- Session identifier- Returns:
- The list of tasks
- Throws:
Exception
- error in the server
-
getTask
WSTask getTask(String sid, String name) throws Exception
Gets a specific task- Parameters:
sid
- identifier of the sessionname
- unique name of the task- Returns:
- All task's metadata
- Throws:
Exception
- error in the server
-
enable
void enable(String sid, String name) throws Exception
Enables a task- Parameters:
sid
- Session identifiername
- The name of the task- Throws:
Exception
- error in the scheduling system
-
disable
void disable(String sid, String name) throws Exception
Disables a task- Parameters:
sid
- Session identifiername
- The name of the task- Throws:
Exception
- error in the scheduling system
-
start
void start(String sid, String name) throws Exception
Starts the execution of a task- Parameters:
sid
- Session identifiername
- The name of the task- Throws:
Exception
- error in the scheduling system
-
stop
void stop(String sid, String name) throws Exception
Stops the execution of a task- Parameters:
sid
- Session identifiername
- The name of the task- Throws:
Exception
- error in the scheduling system
-
-