Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomDataset

java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
de.espirit.firstspirit.access.store.templatestore.gom.GomDataset
All Implemented Interfaces:
LabelFactoryProvider, GomCheckable, GomElement, GomFormElement, GomHideable, GomIndexTreatment, GomLangInfoProvider, GomSearchRelevancy, GomTransferReceiver, LineBreakable, RelationEnabling, Serializable
@NonExtendable public class GomDataset extends AbstractGomFormElement implements RelationEnabling, LabelFactoryProvider, GomTransferReceiver, GomIndexTreatment
Choose objects from a content store view
Since:
4.2
See Also:

  • Field Details

  • Constructor Details

    • GomDataset

      public GomDataset()

  • Method Details

    • getDefaultTag

      protected String getDefaultTag()
      Description copied from class: AbstractGomElement
      Return the default tag for a gom element.
      Specified by:
      getDefaultTag in class AbstractGomElement
      Returns:
      The elements default tag.

    • getAllowNew

      public YesNo getAllowNew()
      Indicates if it is allowed to add new entries.
      Since:
      4.2

    • setAllowNew

      public void setAllowNew(YesNo value)
      Sets if it is allowed to add new entries.
      Since:
      4.2

    • getAllowChoose

      public YesNo getAllowChoose()
      Indicates if it is allowed to choose existing data entries.
      Since:
      3.0

    • setAllowChoose

      public void setAllowChoose(YesNo allowChoose)
      Sets if it is allowed to choose existing data entries.
      Since:
      3.0

    • getAllowEdit

      public YesNo getAllowEdit()
      Indicates if it is allowed to edit entries.
      Since:
      4.2

    • setAllowEdit

      public void setAllowEdit(YesNo value)
      Sets if it is allowed to edit entries.
      Since:
      4.2

    • getAllowDelete

      public YesNo getAllowDelete()
      Indicates if it is allowed to delete entries.
      Since:
      4.2

    • setAllowDelete

      public void setAllowDelete(YesNo delete)
      Sets if it is allowed to delete entries.
      Since:
      4.2

    • setAllowsDelete

      @Deprecated(since="4.2") public void setAllowsDelete(YesNo delete)
      Deprecated.
      since 4.2 - use setAllowDelete(YesNo) instead
      Sets if it is allowed to delete entries.
      Since:
      4.2

    • getAllowsDelete

      @Deprecated(since="4.2") public YesNo getAllowsDelete()
      Deprecated.
      since 4.2 - use getAllowDelete() instead
      Indicates if it is allowed to delete entries.
      Since:
      4.2

    • getSources

      public GomContentReferenceList getSources()
      Content nodes to choose from.
      Since:
      4.2

    • getHeight

      public PositiveInteger getHeight()
      Component height in pixels.
      Since:
      4.2

    • setHeight

      public void setHeight(PositiveInteger height)
      Sets the component height in pixels.
      Since:
      4.2

    • getLegacytemplate

      public GomDataset.GomLegacyTableTemplateElement getLegacytemplate()
      Legacy - reference to table template for conversion from CMS_INPUT_OBJECTCHOOSER
      Since:
      4.2.402

    • setLegacytemplate

      public void setLegacytemplate(GomDataset.GomLegacyTableTemplateElement value)
      Legacy - set the reference to table template for conversion from CMS_INPUT_OBJECTCHOOSER
      Since:
      4.2.402

    • getLangInfos

      public GomExpressionLangInfos getLangInfos()
      Description copied from class: AbstractGomFormElement
      Provides language dependent information on this form element, like a label and description for multiple languages.
      Specified by:
      getLangInfos in interface GomLangInfoProvider
      Overrides:
      getLangInfos in class AbstractGomFormElement
      Returns:
      A language information container.

    • getLabelFactory

      @NotNull public @NotNull LabelFactory<? extends Label> getLabelFactory()
      Description copied from interface: LabelFactoryProvider
      Get a label factory.
      Specified by:
      getLabelFactory in interface LabelFactoryProvider
      Returns:
      The label factory.

    • getMode

      @Nullable public @Nullable DatasetMode getMode()
      The dataset representation mode (SiteArchitect only setting)
      Since:
      4.2

    • setMode

      public void setMode(DatasetMode mode)
      Define the dataset representation mode (SiteArchitect only setting)
      Since:
      4.2

    • getSelectorMode

      public DatasetSelectorMode getSelectorMode()
      The dataset selector mode. Will be ignored when operating in Combobox mode. (SiteArchitect only setting)
      Since:
      5.1.504

    • setSelectorMode

      public void setSelectorMode(DatasetSelectorMode selectorMode)
      Define the dataset selector mode. Will be ignored when operating in Combobox mode. (SiteArchitect only setting)
      Since:
      5.1.504

    • getIndexTreatment

      public Treatment getIndexTreatment()
      Provides the treatment option for following associations.
      Specified by:
      getIndexTreatment in interface GomIndexTreatment
      Returns:
      The desired indexing treatment.
      Since:
      5.2.12

    • setIndexTreatment

      public void setIndexTreatment(@Nullable @Nullable Treatment treatment)
      Sets the treatment option for following associations.
      Specified by:
      setIndexTreatment in interface GomIndexTreatment
      Parameters:
      treatment - The treatment to be used.
      Since:
      5.2.12

    • verify

      public void verify() throws IllegalStateException
      Description copied from class: AbstractGomFormElement
      Verifies the form element's state. In this generic part, checks for the required name and language information.
      Specified by:
      verify in interface GomCheckable
      Overrides:
      verify in class AbstractGomFormElement
      Throws:
      IllegalStateException - if any requirement is violated.

    • validate

      public void validate(GomCheckable.Context context) throws GomValidationError
      Description copied from class: AbstractGomFormElement
      Validates the form element's state with respect to the given context. This generic stub does not check anything.
      Specified by:
      validate in interface GomCheckable
      Overrides:
      validate in class AbstractGomFormElement
      Parameters:
      context - The context to validate for, must not be null.
      Throws:
      GomValidationError - if any requirement is violated.

    • getTransferConstraints

      public TransferConstraint getTransferConstraints(SpecialistsBroker broker)
      Description copied from interface: GomTransferReceiver
      Returns a TransferConstraint object for this element, which describes the store element based transfer restrictions.
      Specified by:
      getTransferConstraints in interface GomTransferReceiver
      Parameters:
      broker - Broker for requesting services or providers.
      Returns:
      transfer constraint

    • allowsNew

      public boolean allowsNew()
      Convenience API for getAllowNew() returning a boolean value.
      Returns:
      true if it is allowed to add new entries, false otherwise
      Since:
      4.2

    • allowsEdit

      public boolean allowsEdit()
      Convenience API for getAllowEdit() returning a boolean value.
      Returns:
      true if it is allowed to edit entries, false otherwise
      Since:
      4.2

    • allowsDelete

      public boolean allowsDelete()
      Convenience API for getAllowDelete() returning a boolean value.
      Returns:
      true if it is allowed to delete entries, false otherwise
      Since:
      4.2

    • allowsChoosing

      public boolean allowsChoosing()
      Convenience API for getAllowChoose() returning a boolean value.
      Returns:
      true if it is allowed to choose existing data entries, false otherwise
      Since:
      4.2

    • height

      public int height()
      Convenience API for getHeight() returning an integer value.
      Returns:
      the height of the component in pixels.
      Since:
      4.2

    • sources

      @NotNull public @NotNull List<String> sources()
      Convenience API for getSources() returning a list of strings.
      Returns:
      the names of all sources in the same order as defined in getSources(). May return an empty list but never null.
      Since:
      4.2

    • allowsRelations

      public boolean allowsRelations()
      Description copied from interface: RelationEnabling
      Indicates whether foreign key relationships are supported as value source.
      Specified by:
      allowsRelations in interface RelationEnabling
      Returns:
      true, if supported.

    • expressions

      @NotNull public @NotNull Map<String,String> expressions()
      Convenience API for getLangInfos() returning a map from GomLangInfo#toString() to GomExpressionLangInfo.getExpression().
      Returns:
      A map from the string representation to the expression. May be empty but never null.
      Since:
      4.2

    • mode

      @NotNull public @NotNull DatasetMode mode()
      Convenience API returning a non-null value for getMode()
      Returns:
      The mode or DatasetMode.DIALOG if unset.
      Since:
      4.2

    • selectorMode

      public DatasetSelectorMode selectorMode()
      Convenience API returning a non-null value for getSelectorMode()
      Returns:
      The mode or DatasetSelectorMode.DIALOG if unset.
      Since:
      5.1.504