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

Class GomReference

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.GomReference
All Implemented Interfaces:
GomCheckable, GomElement, GomFormElement, GomHideable, GomLangInfoProvider, GomProjectProvider, GomSearchRelevancy, GomTransferHandling, GomTransferReceiver, LineBreakable, Serializable
@NonExtendable public class GomReference extends AbstractGomFormElement implements GomProjectProvider, GomTransferReceiver, GomTransferHandling
Generic editor for references based on Uid and UidType
Since:
4.2.9
See Also:

  • Field Details

  • Constructor Details

    • GomReference

      public GomReference()

  • 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.

    • getImagePreview

      public YesNo getImagePreview()
      Indicates if a thumbnail is shown
      Since:
      4.2.9

    • setImagePreview

      public void setImagePreview(YesNo imagePreview)
      Indicates if a thumbnail is shown
      Since:
      4.2.9

    • getUpload

      public YesNo getUpload()
      Indicates if uploading of data is allowed
      Since:
      4.2.9

    • setUpload

      public void setUpload(YesNo upload)
      Sets if uploading of data is allowed
      Since:
      4.2.9

    • getAllowLanguageDependentUpload

      @Deprecated(since="5.0") public YesNo getAllowLanguageDependentUpload()
      Deprecated.
      since 5.0 - no replacement
      Indicates if uploading language-dependent media is allowed
      Since:
      4.2.9

    • setAllowLanguageDependentUpload

      @Deprecated(since="5.0") public void setAllowLanguageDependentUpload(YesNo allowLanguageDependentUpload)
      Deprecated.
      since 5.0 - no replacement
      Sets if uploading language-dependent media is allowed
      Since:
      4.2.9

    • getProjects

      @NotNull public @NotNull GomStorableProjectList getProjects()
      Description copied from interface: GomProjectProvider
      Projects to be used as sources
      Specified by:
      getProjects in interface GomProjectProvider

    • getFilter

      @NotNull public @NotNull GomFilterList getFilter()
      Project filters for allowed reference types available for selection (selection dialog)
      Since:
      4.2.9

    • getSections

      public SectionMode getSections()
      Project filters for allowed reference types available for selection (selection dialog)
      Since:
      4.2.106

    • setSections

      public void setSections(SectionMode sections)
      Set project filters for allowed reference types available for selection (selection dialog)
      Since:
      4.2.106

    • 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

    • getTransferTypes

      public List<TransferType<?>> getTransferTypes(SpecialistsBroker broker)
      Description copied from interface: GomTransferHandling
      Returns a list of supported TransferType's, or null if transfer is not supported.
      Specified by:
      getTransferTypes in interface GomTransferHandling
      Parameters:
      broker - Broker for requesting services or providers.
      Returns:
      supported transfer types, or null.

    • showsThumbnail

      public boolean showsThumbnail()
      Convenience API for getImagePreview() returning a boolean value
      Since:
      4.2.9

    • allowsUpload

      public boolean allowsUpload()
      Convenience API for getUpload() returning a boolean value
      Since:
      4.2.9

    • allowsLanguageDependentUpload

      @Deprecated(since="5.0") public boolean allowsLanguageDependentUpload()
      Deprecated.
      since 5.0 - no replacement
      Convenience API for getAllowLanguageDependentUpload() returning a boolean value
      Since:
      4.2.9

    • sections

      @NotNull public @NotNull SectionMode sections()
      Convenience API for getAllowLanguageDependentUpload() returning a non-null value
      Returns:
      the value of getSections() or SectionMode.YES if unset
      Since:
      4.2.106

    • filter

      public GomFilterList filter()
      Project filters for allowed reference types available for selection (selection dialog)
      Since:
      4.2.106

    • projectConstraints

      public List<ProjectConstraint> projectConstraints()
      Description copied from interface: GomProjectProvider
      Get the list of defined constraints.
      Specified by:
      projectConstraints in interface GomProjectProvider
      Returns:
      The list of project constraints.