Package com.logicaldoc.form
Class FormTool
java.lang.Object
com.logicaldoc.form.FormTool
Utility methods to handle forms from within Automation
- Since:
- 8.7
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
delete
(long formId) Deletes a formvoid
fill
(com.logicaldoc.core.document.Document document) Fills the form of a document with the values and updates the file of the current versionfindById
(long formId) Retrieves a form by it's identifierRetrieves a form by it's alternate identifiervoid
Saves / updates a form into the databasewebformEditUrl
(long docId) Builds the webform url for editing the responses after submitwebformUrl
(Form form) Builds the webform url of a formwebformUrl
(Form form, Map<String, Object> prefilled) Builds the webform url with pre-filled fields
-
Constructor Details
-
FormTool
public FormTool()
-
-
Method Details
-
webformUrl
Builds the webform url of a form- Parameters:
form
- the form- Returns:
- the webform permalink
-
webformUrl
Builds the webform url with pre-filled fields- Parameters:
form
- the formprefilled
- optional map of pre-filled fields- Returns:
- the webform pre-filled link
-
webformEditUrl
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
Retrieves a form by it's identifier- Parameters:
formId
- identifier of the form- Returns:
- the form object
-
findById
Retrieves a form by it's alternate identifier- Parameters:
formId
- identifier of the form- Returns:
- the form object
-
store
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
-