Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Scout/Concepts/FormData
| Scout |
| Wiki Home |
| Website |
| Download • Git |
| Community |
| Forums • Blog • Twitter • G+ |
| Bugzilla |
| Bugzilla |
FormData is the standard data transfer object for forms between the client Plug-In and the server.
- extends:
AbstractFormData
Contents
Description
TODO
Add a description
Add a description
Contains a transfer object for each field and each variable of a form.
Usage
- Used as parameter of the
prepareCreate(..),create(..),load(..),store(..)functions in the process service.
- Importation in Form: Load and Store events of FormHandler:
-
exportFormData() - service call (depending of the action exectuted with the ProcessService)
-
importFormData()
-
Access
TODO
Add a description and example of how to access to a value, how to know if a value was set
Add a description and example of how to access to a value, how to know if a value was set
Generation
SDK Support
- Generation of FormData with the Explorer View
TODO
Add a screenshot
Add a screenshot
FormData anotation
-
FormDataFormData annotation- Is needed on the form Class
Structure of a FormData
The FormData depends from the Form it contains the data. The SDK generate:
- For each ValueField a AbstractValueFieldData<T> is generated.
- For each TableField a TableData is generated.
- For each form-variable an AbstractPropertyData<T>
The inner-class structure from the composite field (like groupboxes) get lost, unless Group-Box templates are used.
The value fields properties (getConfiguredMandatory(), getConfiguredMaxValue(), getConfiguredMaxLength()...) are mapped to ValidationRules conatained in the formData. Those rules are used to redo the basic UI client-side validations on the server.