Package de.espirit.firstspirit.access.editor.reference

Interface Reference

public interface Reference
A reference is either an internal reference (e.g. "media:logo"), a remote reference (e.g. "media:logo, remote:MainProject") or an external reference (e.g. "http://www.google.com").
A reference is broken if the reference name couldn't be found.
Since:
3.1.158
See Also:

  • Field Details

  • Method Details

    • getTypeName

      String getTypeName()
      Returns the type of the reference.
      Returns:
      One of the following values:
      Since:
      3.1.158

    • getLanguage

      Language getLanguage()
      Returns the language of the reference.
      Returns:
      the language of the reference.
      Since:
      3.1.158

    • getReferencedObject

      Object getReferencedObject()
      Returns the referenced object.
      Returns:
      The url for external references, the referenced StoreElement for internal references, or null for broken references.
      Since:
      3.1.158

    • getRemoteName

      String getRemoteName()
      Returns the symbolic name of the remote project configuration.
      Returns:
      symbolic name of the remote project or null for a non-remote reference.
      Since:
      3.1.324
      See Also:

    • setReferencedObject

      void setReferencedObject(Object value)
      Sets the (local) referenced object.
      Parameters:
      value - new referenced object.
      Since:
      3.1.158

    • isBroken

      boolean isBroken()
      Internal references may be broken, e.g. "media:logo" when no media object with the name "logo" exists. Use getReferenceString() to get more information for the desired target.
      The target of external references is not checked, e.g if an invalid url is specified for an external reference, isBroken() returns false.
      Returns:
      true if this is an internal reference and the target does not exist
      Since:
      3.1.172

    • isRemote

      boolean isRemote()
      Returns id this reference is a remote reference.
      Returns:
      true if this reference is a remote reference.
      Since:
      3.1.324

    • getReferenceString

      String getReferenceString()
      Returns the reference string.
      Returns:
      The reference string, e.g. "media:logo" for an internal reference or "http://www.google.com" for external reference
      Since:
      3.1.172

    • getReferencedStoreType

      Store.Type getReferencedStoreType()
      Returns the store type.
      Returns:
      The store type for internal references and null for external references.
      Since:
      4.0.17

    • getReferenceEntry

      @Deprecated(forRemoval=true) ReferenceEntry getReferenceEntry()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.2.24 - no replacement
      Returns null.
      Since:
      3.1.324

    • getReferenceEntry

      ReferenceEntry getReferenceEntry(UserService userService, boolean release)
      Returns reference entry.
      Returns:
      the reference entry.
      Since:
      4.2.24