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
  • 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

      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(List<Long> ids) throws ServerException
      Throws:
      ServerException
    • deleteTriggers

      void deleteTriggers(List<Long> ids) throws ServerException
      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

      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, List<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