Package org.opencastproject.elasticsearch.index.objects.series

Class Series

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

  • 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 series
      See Also:

  • Constructor Details

    • Series

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

    • Series

      public Series(String identifier, String organization)
      The series identifier.
      Parameters:
      identifier - the object identifier
      organization - the organization

    • Series

      public Series(String identifier, String organization, String creator)
      The series identifier.
      Parameters:
      identifier - the object identifier
      organization - the organization

  • Method Details

    • createUnmarshaller

      public static javax.xml.bind.Unmarshaller createUnmarshaller() throws IOException
      Create an unmarshaller for series
      Returns:
      an unmarshaller for series
      Throws:
      IOException

    • getIdentifier

      public String getIdentifier()
      Returns the series identifier.
      Returns:
      the identifier

    • setTitle

      public void setTitle(String title)
      Sets the series title.
      Parameters:
      title - the title

    • getTitle

      public String getTitle()
      Returns the series title.
      Returns:
      the title

    • setDescription

      public void setDescription(String description)
      Sets the series description.
      Parameters:
      description - the description

    • getDescription

      public String getDescription()
      Returns the series description.
      Returns:
      the description

    • setSubject

      public void setSubject(String subject)
      Sets the series subject.
      Parameters:
      subject - the subject

    • getSubject

      public String getSubject()
      Returns the series subject.
      Returns:
      the subject

    • getOrganization

      public String getOrganization()
      Returns the series organization.
      Returns:
      the organization

    • setLanguage

      public void setLanguage(String language)
      Sets the series language.
      Parameters:
      language - the language

    • getLanguage

      public String getLanguage()
      Returns the series language.
      Returns:
      the language

    • setCreator

      public void setCreator(String creator)
      Sets the series creator.
      Parameters:
      creator - the creator

    • getCreator

      public String getCreator()
      Returns the series creator.
      Returns:
      the creator

    • setLicense

      public void setLicense(String license)
      Sets the series license.
      Parameters:
      license - the license

    • getLicense

      public String getLicense()
      Returns the series license.
      Returns:
      the license

    • setAccessPolicy

      public void setAccessPolicy(String accessPolicy)
      Sets the series access policy.
      Parameters:
      accessPolicy - the access policy

    • getAccessPolicy

      public String getAccessPolicy()
      Returns the series access policy.
      Returns:
      the access policy

    • setManagedAcl

      public void setManagedAcl(String managedAcl)
      Sets the name of the managed ACL used by the series.
      Parameters:
      managedAcl - the managed ACL name

    • getManagedAcl

      public String getManagedAcl()
      Returns the name of the managed ACL, if the series does not have a custom ACL.
      Returns:
      the managed ACL name

    • setCreatedDateTime

      public void setCreatedDateTime(Date createdDateTime)
      Sets the series created date and time.
      Parameters:
      createdDateTime - the date and time the series was created.

    • getCreatedDateTime

      public Date getCreatedDateTime()
      Returns the series date and time created.
      Returns:
      the created date and time

    • addOrganizer

      public void addOrganizer(String organizer)
      Add an organizer
      Parameters:
      organizer - The organizer's name.

    • setOrganizers

      public void setOrganizers(List<String> organizers)
      Sets the list of organizers.
      Parameters:
      organizers - the organizers for this event

    • getOrganizers

      public List<String> getOrganizers()
      Returns the series presenters.
      Returns:
      the presenters

    • addContributor

      public void addContributor(String contributor)
      Add a contributor
      Parameters:
      contributor - The contributor's name.

    • setContributors

      public void setContributors(List<String> contributors)
      Sets the list of contributors.
      Parameters:
      contributors - the contributors for this event

    • getContributors

      public List<String> getContributors()
      Returns the series contributors.
      Returns:
      the contributors

    • addPublisher

      public void addPublisher(String publisher)
      Add a publisher
      Parameters:
      publisher - The publisher's name.

    • setPublishers

      public void setPublishers(List<String> publishers)
      Sets the list of publishers.
      Parameters:
      publishers - the publishers for this event

    • getPublishers

      public List<String> getPublishers()
      Returns the series publishers.
      Returns:
      the publishers

    • setRightsHolder

      public void setRightsHolder(String rightsHolder)
      Sets the series rights holder.
      Parameters:
      rightsHolder - holder the rights holder

    • getRightsHolder

      public String getRightsHolder()
      Returns the series rights holder.
      Returns:
      the rights holder

    • setTheme

      public void setTheme(Long theme)
      Sets the theme for this series
      Parameters:
      theme - the theme

    • getTheme

      public Long getTheme()
      Returns the theme of this series
      Returns:
      the theme of this series

    • setExtendedMetadata

      public void setExtendedMetadata(String type, Map<String,List<String>> metadata)
      Sets the external metadata for a catalog type.
      Parameters:
      type - The catalog type
      metadata - The metadata

    • removeExtendedMetadata

      public void removeExtendedMetadata(String type)
      Removes the external metadata for a catalog type.
      Parameters:
      type - The catalog type

    • resetExtendedMetadata

      public void resetExtendedMetadata()
      Removes all external metadata.

    • getExtendedMetadata

      public Map<String,Map<String,List<String>>> getExtendedMetadata()
      Returns the extended metadata
      Returns:
      the extended metadata in a map by catalog type

    • valueOf

      public static Series valueOf(InputStream xml, javax.xml.bind.Unmarshaller unmarshaller) throws IOException
      Reads the series from the input stream.
      Parameters:
      xml - the input stream
      unmarshaller - the unmarshaller to use
      Returns:
      the deserialized recording event
      Throws:
      IOException

    • valueOfJson

      public static Series valueOfJson(InputStream json) throws IOException, org.codehaus.jettison.json.JSONException, XMLStreamException, javax.xml.bind.JAXBException
      Reads the series from the input stream.
      Parameters:
      json - the input stream
      Returns:
      the deserialized recording event
      Throws:
      org.codehaus.jettison.json.JSONException
      XMLStreamException
      javax.xml.bind.JAXBException
      IOException

    • toJSON

      public String toJSON()
      Serializes the series.
      Returns:
      the serialized series

    • toXML

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