Skip to main content
Jump to: navigation, search

Difference between revisions of "Scout/Concepts/FormData"

(Add Class)
(struturation of the article, some idea on the content)
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}}.
  
* {{ScoutJavadoc|FormData|A}} FormData annotation > "CREATE EXTERNAL"
+
=== Usage ===
 +
* Used as parameter of the <code>prepareCreate(..)</code>, <code>create(..)</code>, <code>load(..)</code>, <code>store(..)</code> functions in the {{ScoutLink|Concepts|Process Service|process service}}.
  
* Importation in {{ScoutLink|Concepts|Form|Form}}
+
* Importation in {{ScoutLink|Concepts|Form|Form}}: {{ScoutEvent|Load}} and {{ScoutEvent|Store}} events of {{ScoutLink|Concepts|Form Handler|FormHandler}}:
 +
** <code>exportFormData()</code>
 +
** service call (depending of the action exectuted with the {{ScoutLink|Concepts|Process Service|ProcessService}})
 +
** <code>importFormData()</code>
  
* Parameter of the prepareCreate, create, load, store functions in the {{ScoutLink|Concepts|Process Service|process service}}
+
=== Access ===
 +
{{note|TODO|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 {{ScoutLink|SDK|Explorer_View|Explorer View}}
  
== Screenshot ==
+
{{note|TODO|Add a screenshot}}
{{note|TODO|Add a screenshot (or remove this section, if there is no screenshot to make)}}
+
  
 +
=== FormData anotation ===
 +
* {{ScoutJavadoc|FormData|A}} FormData annotation
 +
** Is needed on the form Class
 +
** "CREATE EXTERNAL" parameter is needed on fiels (a GroupBoxField for example) defined in an external Class that contains other fields.
  
== Properties ==
+
== Structure of a FormData ==
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
+
{{note|TODO|Describe the structure of a FormData. Help to understand what the SDK does}}
 
+
{{note|TODO|Add a description of important properties. The idea is not to recreate the JavaDoc of the getConfiguredXxxxxx() methods but to provide explanations, best practice, example... Group the properties by domain.}}
+
 
+
 
+
== Events ==
+
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
+
 
+
{{note|TODO|Add a description of important events. The idea is not to recreate the JavaDoc of the execXxxxxx() methods but to provide explanations, best practice, example... Group the events by domain.}}
+
  
  

Revision as of 13:00, 4 November 2010


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitterG+
Bugzilla
Bugzilla


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

  • extends: C obj.pngAbstractFormData

Description

Note.png
TODO
Add a description

Contains a transfert 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
    • "CREATE EXTERNAL" parameter is needed on fiels (a GroupBoxField for example) defined in an external Class that contains other fields.

Structure of a FormData

Note.png
TODO
Describe the structure of a FormData. Help to understand what the SDK does


See Also

Back to the top