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

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

Nested Classes

Modifier and Type	Interface	Description
static class	AutomationService.Instance

Method Summary

Modifier and Type	Method	Description
void	applyTriggersToTree(long rootId)	Applies the triggers on a root folder to all the subtree
void	deleteRoutines(long[] ids)
void	deleteTriggers(long[] ids)
void	execute(GUIAutomationRoutine routine, Long[] docIds, Long folderId)	Executes a routine or a given script
GUIAutomationRoutine	getRoutine(long id)	Loads a given routine from the database
GUIAutomationTrigger	getTrigger(long id)	Loads a given trigger from the database
GUIAutomationRoutine	saveRoutine(GUIAutomationRoutine routine)	Creates or updates a routine
GUIAutomationTrigger	saveTrigger(GUIAutomationTrigger trigger)	Creates or updates a trigger

Method Detail

saveRoutine

GUIAutomationRoutine saveRoutine(GUIAutomationRoutine routine)
                          throws ServerException

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

GUIAutomationRoutine getRoutine(long id)
                         throws ServerException

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

void deleteRoutines(long[] ids)
             throws ServerException

Throws:

ServerException

deleteTriggers

void deleteTriggers(long[] ids)
             throws ServerException

Throws:

ServerException

saveTrigger

GUIAutomationTrigger saveTrigger(GUIAutomationTrigger trigger)
                          throws ServerException

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

GUIAutomationTrigger getTrigger(long id)
                         throws ServerException

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

void applyTriggersToTree(long rootId)
                  throws ServerException

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

void execute(GUIAutomationRoutine routine,
             Long[] docIds,
             Long folderId)
      throws ServerException

Executes a routine or a given script

Parameters:

routine - The automation routine to execute, if the routine.id=0 then the routine.script is executed, otherwise the referenced routine is picked from the database and the extended attributes of routine are used as input parameters.

docIds - selected documents (optional)

folderId - selected folders (optional)

Throws:

ServerException - an error happened in the server application