Interface AutomationService
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
@RemoteServiceRelativePath("automation")
public interface AutomationService
extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Automation Service.
- Since:
- 8.1
- Author:
- Marco Meschieri - LogicalDOC
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyTriggersToTree
(long rootId) Applies the triggers on a root folder to all the subtreevoid
deleteRoutines
(List<Long> ids) void
deleteTriggers
(List<Long> ids) void
execute
(GUIAutomationRoutine routine, List<Long> docIds, Long folderId) Executes a routine or a given scriptgetRoutine
(long id) Loads a given routine from the databasegetTrigger
(long id) Loads a given trigger from the databasesaveRoutine
(GUIAutomationRoutine routine) Creates or updates a routinesaveTrigger
(GUIAutomationTrigger trigger) Creates or updates a trigger
-
Method Details
-
saveRoutine
Creates or updates a routine- Parameters:
routine
- the routine to save- Returns:
- the saved routine
- Throws:
ServerException
- an error happened in the server application
-
getRoutine
Loads a given routine from the database- Parameters:
id
- identifier of the routine- Returns:
- the routine retrieved by the server application
- Throws:
ServerException
- an error happened in the server application
-
deleteRoutines
- Throws:
ServerException
-
deleteTriggers
- Throws:
ServerException
-
saveTrigger
Creates or updates a trigger- Parameters:
trigger
- the automation trigger to save- Returns:
- the saved trigger
- Throws:
ServerException
- an error happened in the server application
-
getTrigger
Loads a given trigger from the database- Parameters:
id
- identifier of the trigger- Returns:
- the automation trigger retrieved by the server application
- Throws:
ServerException
- an error happened in the server application
-
applyTriggersToTree
Applies the triggers on a root folder to all the subtree- Parameters:
rootId
- identifier of the root folder- Throws:
ServerException
- an error happened in the server application
-
execute
Executes a routine or a given script- Parameters:
routine
- The automation routine to execute, if theroutine.id=0
then theroutine.script
is executed, otherwise the referenced routine is picked from the database and the extended attributes ofroutine
are used as input parameters.docIds
- selected documents (optional)folderId
- selected folders (optional)- Throws:
ServerException
- an error happened in the server application
-