Package de.espirit.firstspirit.access.editor.value

Interface ElementReference

public interface ElementReference
Definition of value transport container holding a reference to a firstspirit element.
Since:
4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Referenceable
    get()
    Provides the referenced element.
    @Nullable DocumentGroup
    getDocumentGroup()
    Provides the referenced element as firstspirit document group, if applicable.
    Language
    getLanguage()
    Provides the language this reference is stored for.
    @Nullable Media
    getMedia()
    Provides the referenced element as firstspirit media object, if applicable.
    @Nullable PageRef
    getPageRef()
    Provides the referenced element as page ref, if applicable.
    String
    getReferenceName()
    Provides the name of the reference.
    String
    getRemote()
    Provides the symbolic remote project name, if this is a remote reference.
    @Nullable Section<?>
    getSection()
    Provides the section that may be referenced together with the element.
    String
    getSectionName()
    Provides the name of the section referenced together with the element, if any.
    boolean
    isEmpty()
    Indicates this container to be empty.
    void
    set(@Nullable Referenceable reference)
    Sets the referenced element.
    void
    setDocumentGroup(DocumentGroup documentGroup)
    Sets the given document group as referenced element.
    void
    setMedia(Media medium)
    Sets the given media object as referenced element.
    void
    setPageRef(PageRef pageRef)
    Sets the given page ref as referenced element.
    void
    setReferenceName(String name)
    Defines the name for the reference.
    void
    setRemote(@Nullable String name)
    Defines the symbolic remote project name, if the reference points to a remote project.
    void
    setSection(@Nullable Section<?> section)
    Defines a section being referenced together with the element.
    void
    setSectionName(String name)
    Defines a section to be referenced together with the main element.

  • Method Details

    • get

      Referenceable get()
      Provides the referenced element.
      Returns:
      The referenceable element.
      Since:
      4.0

    • set

      void set(@Nullable @Nullable Referenceable reference)
      Sets the referenced element.
      Parameters:
      reference - The referenceable element.
      Since:
      4.0

    • isEmpty

      boolean isEmpty()
      Indicates this container to be empty.
      Returns:
      true, if empty.
      Since:
      4.0

    • getLanguage

      Language getLanguage()
      Provides the language this reference is stored for.
      Returns:
      The language.
      Since:
      4.0

    • getReferenceName

      String getReferenceName()
      Provides the name of the reference.
      Returns:
      The reference's name.
      Since:
      4.0.120

    • setReferenceName

      void setReferenceName(String name)
      Defines the name for the reference.
      Parameters:
      name - The name.
      Since:
      4.0.120

    • getRemote

      String getRemote()
      Provides the symbolic remote project name, if this is a remote reference.
      Returns:
      The remote name.
      Since:
      4.2.14

    • setRemote

      void setRemote(@Nullable @Nullable String name)
      Defines the symbolic remote project name, if the reference points to a remote project.
      Parameters:
      name - The symbolic name.
      Since:
      4.2.14

    • getSection

      @Nullable @Nullable Section<?> getSection()
      Provides the section that may be referenced together with the element.
      Returns:
      The section.
      Since:
      4.0

    • setSection

      void setSection(@Nullable @Nullable Section<?> section)
      Defines a section being referenced together with the element.
      Parameters:
      section - The section.
      Since:
      4.0

    • getPageRef

      @Nullable @Nullable PageRef getPageRef()
      Provides the referenced element as page ref, if applicable.
      Returns:
      The element as page ref or null.
      Since:
      4.0

    • setPageRef

      void setPageRef(PageRef pageRef)
      Sets the given page ref as referenced element.
      Parameters:
      pageRef - A page ref.
      Since:
      4.0

    • getMedia

      @Nullable @Nullable Media getMedia()
      Provides the referenced element as firstspirit media object, if applicable.
      Returns:
      The media object or null.
      Since:
      4.0

    • setMedia

      void setMedia(Media medium)
      Sets the given media object as referenced element.
      Parameters:
      medium - A media object.
      Since:
      4.0

    • getDocumentGroup

      @Nullable @Nullable DocumentGroup getDocumentGroup()
      Provides the referenced element as firstspirit document group, if applicable.
      Returns:
      The document group or null.
      Since:
      4.0

    • setDocumentGroup

      void setDocumentGroup(DocumentGroup documentGroup)
      Sets the given document group as referenced element.
      Parameters:
      documentGroup - A document group.
      Since:
      4.0

    • getSectionName

      String getSectionName()
      Provides the name of the section referenced together with the element, if any.
      Returns:
      The section name or null.
      Since:
      4.0

    • setSectionName

      void setSectionName(String name)
      Defines a section to be referenced together with the main element.
      Parameters:
      name - The name of the section.
      Since:
      4.0