Package org.opencastproject.elasticsearch.index.objects.theme

Class IndexTheme

java.lang.Object
org.opencastproject.elasticsearch.index.objects.theme.IndexTheme
All Implemented Interfaces:
IndexObject
public class IndexTheme extends Object implements IndexObject
Object wrapper for a theme.

  • Field Details

    • DOCUMENT_TYPE

      public static final String DOCUMENT_TYPE
      The document type
      See Also:

    • XML_SURROUNDING_TAG

      public static final String XML_SURROUNDING_TAG
      The name of the surrounding XML tag to wrap a result of multiple theme
      See Also:

  • Constructor Details

    • IndexTheme

      public IndexTheme()
      Required default no arg constructor for JAXB.

    • IndexTheme

      public IndexTheme(long identifier, String organization)
      Parameters:
      identifier - the theme identifier
      organization - the organization

  • Method Details

    • getIdentifier

      public long getIdentifier()

    • getCreationDate

      public Date getCreationDate()

    • setCreationDate

      public void setCreationDate(Date creationDate)

    • isDefault

      public boolean isDefault()

    • setDefault

      public void setDefault(boolean isDefault)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getCreator

      public String getCreator()

    • setCreator

      public void setCreator(String creator)

    • getOrganization

      public String getOrganization()

    • isBumperActive

      public boolean isBumperActive()

    • setBumperActive

      public void setBumperActive(boolean bumperActive)

    • getBumperFile

      public String getBumperFile()

    • setBumperFile

      public void setBumperFile(String bumperFile)

    • isTrailerActive

      public boolean isTrailerActive()

    • setTrailerActive

      public void setTrailerActive(boolean trailerActive)

    • getTrailerFile

      public String getTrailerFile()

    • setTrailerFile

      public void setTrailerFile(String trailerFile)

    • isTitleSlideActive

      public boolean isTitleSlideActive()

    • setTitleSlideActive

      public void setTitleSlideActive(boolean titleSlideActive)

    • getTitleSlideMetadata

      public String getTitleSlideMetadata()

    • setTitleSlideMetadata

      public void setTitleSlideMetadata(String titleSlideMetadata)

    • getTitleSlideBackground

      public String getTitleSlideBackground()

    • setTitleSlideBackground

      public void setTitleSlideBackground(String titleSlideBackground)

    • isLicenseSlideActive

      public boolean isLicenseSlideActive()

    • setLicenseSlideActive

      public void setLicenseSlideActive(boolean licenseSlideActive)

    • getLicenseSlideDescription

      public String getLicenseSlideDescription()

    • setLicenseSlideDescription

      public void setLicenseSlideDescription(String licenseSlideDescription)

    • getLicenseSlideBackground

      public String getLicenseSlideBackground()

    • setLicenseSlideBackground

      public void setLicenseSlideBackground(String licenseSlideBackground)

    • isWatermarkActive

      public boolean isWatermarkActive()

    • setWatermarkActive

      public void setWatermarkActive(boolean watermarkActive)

    • getWatermarkFile

      public String getWatermarkFile()

    • setWatermarkFile

      public void setWatermarkFile(String watermarkFile)

    • getWatermarkPosition

      public String getWatermarkPosition()

    • setWatermarkPosition

      public void setWatermarkPosition(String watermarkPosition)

    • valueOf

      public static IndexTheme valueOf(InputStream xml) throws IOException
      Reads the theme from the input stream.
      Parameters:
      xml - the input stream
      Returns:
      the deserialized theme
      Throws:
      IOException

    • toXML

      public String toXML()
      Serializes the theme to an XML format.
      Returns:
      A String with this theme's content as XML.

    • fromSearchMetadata

      public static IndexTheme fromSearchMetadata(SearchMetadataCollection metadata) throws IOException
      Creates a search result item based on the data returned from the search index.
      Parameters:
      metadata - the search metadata
      Returns:
      the search result item
      Throws:
      IOException - if unmarshalling fails

    • toSearchMetadata

      public SearchMetadataCollection toSearchMetadata()
      Creates search metadata from a theme such that the theme can be stored in the search index.
      Returns:
      the set of metadata