Interface GomSourceProvider

All Superinterfaces:
Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, Workflowable
All Known Subinterfaces:
LinkTemplate, MasterTemplate, PageTemplate, Script, SectionTemplate, StyleTemplate, TableFormatTemplate, TableTemplate, Template, Workflow

public interface GomSourceProvider extends IDProvider
The GOM (gui object model) describes the input form presented to the end user (editor).

You can read and set the xml (getGomSource(), setGomSource(String)), the object model (getGomProvider(), setGomProvider(GomEditorProvider)), and default values (getDefaults(), setDefaults(Data))

Since:
4.0
  • Method Details

    • getGomSource

      String getGomSource()
      Get the source for a GOM based interface description.
      Returns:
      The GOM source.
      Since:
      4.0
    • setGomSource

      void setGomSource(String xml) throws ParsingError
      Set the xml describing the template form.
      Parameters:
      xml - The form defining xml.
      Throws:
      ParsingError - if the xml is not valid.
      Since:
      4.2
    • getFormDefaults

      FormData getFormDefaults()
      Get the form data containing the form's default values.
      Returns:
      The defaults containing form data.
      Since:
      5.0.100
    • setFormDefaults

      void setFormDefaults(FormData formData)
      Set the default values via a form data object. Use the fallback language to define fallback values in given defaults form data.
      Parameters:
      formData - The defaults containing form data.
      Since:
      5.0.100
      See Also:
    • getDefaults

      @Deprecated Data getDefaults() throws ParsingError
      Deprecated.
      since 5.0.100 Use getFormDefaults() instead.
      Get the defaults data object.
      Returns:
      The data containing defaults.
      Throws:
      ParsingError - If the current template's XML failed to be parsed.
      Since:
      4.0
    • setDefaults

      @Deprecated void setDefaults(Data data)
      Deprecated.
      since 5.0.100 Use setFormDefaults(FormData) instead.
      Set the defaults data object.
      Parameters:
      data - the default data
      Since:
      4.0
    • getGomProvider

      GomEditorProvider getGomProvider() throws ParsingError
      Get this template's GOM provider containing the hierarchical definition of the templates GUI including structure and input elements.
      Returns:
      The GuiXML provider.
      Throws:
      ParsingError - If the current template's XML failed to be parsed.
      Since:
      4.0
    • setGomProvider

      void setGomProvider(GomEditorProvider gomProvider) throws ParsingError, GomValidationError
      Set the GOM provider to be used by this template.
      Parameters:
      gomProvider - The GOM provider.
      Throws:
      ParsingError - If an error occurred while processing the provider.
      GomValidationError - If the current template is valid.
      Since:
      4.0