Package ch.tocco.nice2.model.form.api

Interface FormModel

All Known Implementing Classes:
FormModelImpl
@Deprecated public interface FormModel
Deprecated.
Get the form-model which has been created by the configuration-reading process. All the returned forms are a read-only-implentation. If you want to change a form, just call Component.createCopy() and change the copy!

If you're interested in templates, look em up in the sperate TemplateModel

  • Method Details

    • getForm

      @Nullable @Nullable Form getForm(String name)
      Deprecated.
      Returns the loaded form by name with user adjustments.
      Parameters:
      name - For example "Address_list", so it's the combination of entity type and view (aka scope).
      Returns:
      Null if no such form.

    • getFormWithoutUsersettings

      @Nullable @Nullable Form getFormWithoutUsersettings(String name)
      Deprecated.
      Returns the loaded form by name without user adjustments.
      Parameters:
      name - For example "Address_list", so it's the combination of entity type and view (aka scope).
      Returns:
      Null if no such form.

    • getForm

      @Nullable @Nullable Form getForm(String entityName, String scope)
      Deprecated.
      Returns the loaded form by name and scope with user adjustments.

      Note: The scope may be a specific or default one. For example there might be a specialized form "Address_create", or just the generic one named "Address_detail" which handles all crud scopes if there are no specific ones (for create, update, delete, read).

      Parameters:
      entityName - For example "Address".
      scope - For example "detail" or "create", in lower case.
      Returns:
      Null if no form in that scope or fallback default scope.

    • getFormWithoutUsersettings

      @Nullable @Nullable Form getFormWithoutUsersettings(String entityName, String scope)
      Deprecated.
      Returns the loaded form by name and scope without user adjustments.

      Note: The scope may be a specific or default one. For example there might be a specialized form "Address_create", or just the generic one named "Address_detail" which handles all crud scopes if there are no specific ones (for create, update, delete, read).

      Parameters:
      entityName - For example "Address".
      scope - For example "detail" or "create", in lower case.
      Returns:
      Null if no form in that scope or fallback default scope.

    • getForms

      Collection<Form> getForms()
      Deprecated.
      Returns all loaded forms. The entries provide the getName() method.

    • onReload

      void onReload()
      Deprecated.