Package io.goobi.viewer.model.cms

Class CMSArchiveConfig

java.lang.Object
io.goobi.viewer.model.cms.CMSArchiveConfig
All Implemented Interfaces:
CMSMediaHolder, CMSMediaMultiHolder, Serializable
@Entity public class CMSArchiveConfig extends Object implements CMSMediaMultiHolder, Serializable
Configuration model for an EAD archive tree embedded in a CMS page.
See Also:

  • Constructor Details

    • CMSArchiveConfig

      public CMSArchiveConfig()

    • CMSArchiveConfig

      public CMSArchiveConfig(String pi)
      Parameters:
      pi - persistent identifier of the archive resource

    • CMSArchiveConfig

      public CMSArchiveConfig(CMSArchiveConfig orig)
      Cloning constructor. Must be updated after any changes to the class.
      Parameters:
      orig - CMSArchiveConfig to clone

  • Method Details

    • getId

      public Long getId()

    • setId

      public void setId(Long id)

    • getPi

      public String getPi()

    • setPi

      public void setPi(String pi)

    • getDateUpdated

      public LocalDateTime getDateUpdated()

    • setDateUpdated

      public void setDateUpdated(LocalDateTime dateUpdated)

    • getTitle

      public TranslatedText getTitle()

    • setTitle

      public void setTitle(TranslatedText title)

    • getPreviewText

      public TranslatedText getPreviewText()

    • setPreviewText

      public void setPreviewText(TranslatedText previewText)

    • getDescription

      public TranslatedText getDescription()

    • setDescription

      public void setDescription(TranslatedText description)

    • getTileImage

      public CMSMediaItem getTileImage()

    • setTileImage

      public void setTileImage(CMSMediaItem tileImage)

    • getHeaderImage

      public CMSMediaItem getHeaderImage()

    • setHeaderImage

      public void setHeaderImage(CMSMediaItem headerImage)

    • getShortDescription

      public String getShortDescription(int maxLength)
      Parameters:
      maxLength - maximum character length
      Returns:
      truncated plaintext

    • setMediaItem

      public void setMediaItem(CMSMediaItem item)
      Description copied from interface: CMSMediaHolder
      setMediaItem.
      Specified by:
      setMediaItem in interface CMSMediaHolder
      Parameters:
      item - a CMSMediaItem object.

    • getMediaItem

      public CMSMediaItem getMediaItem()
      Description copied from interface: CMSMediaHolder
      getMediaItem.
      Specified by:
      getMediaItem in interface CMSMediaHolder
      Returns:
      the associated CMS media item, or null if none is set

    • getMediaFilter

      public String getMediaFilter()
      Description copied from interface: CMSMediaHolder
      A regular expression determining which filenames are shown in the media list and may be uploaded.
      Specified by:
      getMediaFilter in interface CMSMediaHolder
      Returns:
      the regex pattern used to filter acceptable media filenames for this holder

    • getMediaTypes

      public String getMediaTypes()
      Description copied from interface: CMSMediaHolder
      A string representing the allowed media formates for a user. Should be a comma separated list of format names or filename suffixes
      Specified by:
      getMediaTypes in interface CMSMediaHolder
      Returns:
      String

    • hasMediaItem

      public boolean hasMediaItem()
      Description copied from interface: CMSMediaHolder
      hasMediaItem.
      Specified by:
      hasMediaItem in interface CMSMediaHolder
      Returns:
      true if this holder has an associated CMS media item, false otherwise

    • getMediaItemWrapper

      public CategorizableTranslatedSelectable<CMSMediaItem> getMediaItemWrapper()
      Description copied from interface: CMSMediaHolder
      getMediaItemWrapper.
      Specified by:
      getMediaItemWrapper in interface CMSMediaHolder
      Returns:
      the CMS media item wrapped with category and selection state information

    • setMediaItem

      public void setMediaItem(int index, CMSMediaItem item)
      Description copied from interface: CMSMediaMultiHolder
      setMediaItem.
      Specified by:
      setMediaItem in interface CMSMediaMultiHolder
      Parameters:
      index - Index of the media item
      item - a CMSMediaItem object.

    • getMediaItem

      public CMSMediaItem getMediaItem(int index)
      Description copied from interface: CMSMediaMultiHolder
      getMediaItem.
      Specified by:
      getMediaItem in interface CMSMediaMultiHolder
      Parameters:
      index - Index of the media item
      Returns:
      the CMS media item at the given index, or null if none is set

    • getMediaFilter

      public String getMediaFilter(int index)
      Description copied from interface: CMSMediaMultiHolder
      A regular expression determining which filenames are shown in the media list and may be uploaded.
      Specified by:
      getMediaFilter in interface CMSMediaMultiHolder
      Parameters:
      index - Index of the media item
      Returns:
      the regex pattern used to filter acceptable media filenames for the item at the given index

    • getMediaTypes

      public String getMediaTypes(int index)
      Description copied from interface: CMSMediaMultiHolder
      A string representing the allowed media formats for a user. Should be a comma separated list of format names or filename suffixes
      Specified by:
      getMediaTypes in interface CMSMediaMultiHolder
      Parameters:
      index - Index of the media item
      Returns:
      String

    • hasMediaItem

      public boolean hasMediaItem(int index)
      Description copied from interface: CMSMediaMultiHolder
      hasMediaItem.
      Specified by:
      hasMediaItem in interface CMSMediaMultiHolder
      Parameters:
      index - Index of the media item
      Returns:
      true if this holder has an associated CMS media item at the given index, false otherwise

    • getMediaItemWrapper

      public CategorizableTranslatedSelectable<CMSMediaItem> getMediaItemWrapper(int index)
      Description copied from interface: CMSMediaMultiHolder
      getMediaItemWrapper.
      Specified by:
      getMediaItemWrapper in interface CMSMediaMultiHolder
      Parameters:
      index - Index of the media item
      Returns:
      the CMS media item at the given index wrapped with category and selection state information