Wiki source code of Form field validation plugin

Show last authors
1 == Interface IPluginValidationRule ==
2
3 === Uses ===
4
5 * Interface to provide own validation rules for selection in the designer.
6
7 == Method signatures ==
8
9 The plugin interface IPluginValidationRule references all methods provided by the [[Base interface IFCPlugin>>doc:IFCPlugin]]
10 and additionally the following plugin-specific method signatures:
11
12
13 {{panel title="{{code language='java'~}~}public String getKey(){{/code~}~}" triggerable="true" fullwidth="true"}}
14 Key which is used to uniquely determine the validation rule.
15 {{/panel}}
16
17
18 {{panel title="{{code language='java'~}~}String getKeyDisplayName(Locale loc){{/code~}~}" triggerable="true" fullwidth="true"}}
19 Method to retrieve the name of the validation rule for display in the FORMCYCLE designer. Language-dependent names can be returned through the **Locale** object passed.
20 {{/panel}}
21
22
23 {{panel title="{{code language='java'~}~}String getRegex(){{/code~}~}" triggerable="true" fullwidth="true"}}
24 The regular expression to apply for validation.
25 {{/panel}}
26
27
28 {{panel title="{{code language='java'~}~}String getValidationErrorMsg(Locale loc){{/code~}~}" triggerable="true" fullwidth="true"}}
29 Method to provide a message in case of validation errors. Language-dependent messages can be returned through the **Locale** object passed.
30 {{/panel}}