Skip to main content
Jump to: navigation, search

Difference between revisions of "Scout/Concepts/FormData"

(FormData anotation: Remove reference to CREATE EXTERNAL (depreciated))
(Structure of a FormData)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{ScoutPage|cat=Concepts}}
+
{{ScoutPage|cat=Shared}}
  
FormData is the standard data transfert object for {{ScoutLink|Concepts|Form|forms}} between the {{ScoutLink|Concepts|Client Plug-In|client Plug-In}} and the {{ScoutLink|Concepts|Server Plug-In|server}}.
+
FormData is the standard data transfer object for {{ScoutLink|Concepts|Form|forms}} between the {{ScoutLink|Concepts|Client Plug-In|client Plug-In}} and the {{ScoutLink|Concepts|Server Plug-In|server}}.
  
 
* extends: {{ScoutJavadoc|AbstractFormData|C}}
 
* extends: {{ScoutJavadoc|AbstractFormData|C}}
Line 7: Line 7:
 
== Description ==
 
== Description ==
 
{{note|TODO|Add a description}}
 
{{note|TODO|Add a description}}
Contains a transfert object for each {{ScoutLink|Concepts|Field|field}} and each {{ScoutLink|Concepts|Variable|variable}} of a {{ScoutLink|Concepts|Form|form}}.
+
Contains a transfer object for each {{ScoutLink|Concepts|Field|field}} and each {{ScoutLink|Concepts|Variable|variable}} of a {{ScoutLink|Concepts|Form|form}}.
  
 
=== Usage ===
 
=== Usage ===
Line 32: Line 32:
  
 
== Structure of a FormData ==
 
== Structure of a FormData ==
{{note|TODO|Describe the structure of a FormData. Help to understand what the SDK does}}
+
The FormData depends from the {{ScoutLink|Concepts|Form}} it contains the data. The SDK generate:
 +
* For each {{ScoutLink|Concepts|ValueField}} a <tt>AbstractValueFieldData<T></tt> is generated.
 +
* For each {{ScoutLink|Concepts|TableField}} a {{ScoutLink|Concepts|TableData}} is generated.
 +
* For each form-variable an <tt>AbstractPropertyData<T></tt>
  
 +
The inner-class structure from the composite field (like groupboxes) get lost, unless Group-Box templates are used.
 +
 +
The value fields properties (<tt>getConfiguredMandatory()</tt>, <tt>getConfiguredMaxValue()</tt>, <tt>getConfiguredMaxLength()</tt>...) are mapped to <tt>ValidationRules</tt> conatained in the formData. Those rules are used to redo the basic UI client-side validations on the server.
  
 
== See Also ==
 
== See Also ==

Latest revision as of 17:23, 12 September 2014


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitterG+
Bugzilla
Bugzilla


FormData is the standard data transfer object for forms between the client Plug-In and the server.

  • extends: C obj.pngAbstractFormData

Description

Note.png
TODO
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

Note.png
TODO
Add a description and example of how to access to a value, how to know if a value was set


Generation

SDK Support

Note.png
TODO
Add a screenshot


FormData anotation

  • A obj.pngFormData FormData 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.

See Also

Back to the top