Package com.logicaldoc.form

Class FormTool

java.lang.Object
com.logicaldoc.form.FormTool
public class FormTool extends Object
Utility methods to handle forms from within Automation
Since:
8.7
Author:
Marco Meschieri - LogicalDOC

  • Constructor Details

    • FormTool

      public FormTool()

  • Method Details

    • webformUrl

      public String webformUrl(Form form)
      Builds the webform url of a form
      Parameters:
      form - the form
      Returns:
      the webform permalink

    • webformUrl

      public String webformUrl(Form form, Map<String,Object> prefilled)
      Builds the webform url with pre-filled fields
      Parameters:
      form - the form
      prefilled - optional map of pre-filled fields
      Returns:
      the webform pre-filled link

    • webformEditUrl

      public String webformEditUrl(long docId)
      Builds the webform url for editing the responses after submit
      Parameters:
      docId - identifier of the document with the previous responses
      Returns:
      the webform editing link

    • findById

      public Form findById(long formId)
      Retrieves a form by it's identifier
      Parameters:
      formId - identifier of the form
      Returns:
      the form object

    • findById

      public Form findById(String formId)
      Retrieves a form by it's alternate identifier
      Parameters:
      formId - identifier of the form
      Returns:
      the form object

    • store

      public void store(Form form)
      Saves / updates a form into the database
      Parameters:
      form - the form to save

    • delete

      public void delete(long formId)
      Deletes a form
      Parameters:
      formId - identifier of the form

    • fill

      public void fill(com.logicaldoc.core.document.Document document)
      Fills the form of a document with the values and updates the file of the current version
      Parameters:
      document - the form to fill