Package org.opencastproject.publication.api

Interface ConfigurablePublicationService

public interface ConfigurablePublicationService

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_TYPE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opencastproject.job.api.Job
    replace(org.opencastproject.mediapackage.MediaPackage mediaPackage, String channelId, Collection<? extends org.opencastproject.mediapackage.MediaPackageElement> addElements, Set<String> retractElementIds)
    Replaces media package elements.
    org.opencastproject.mediapackage.Publication
    replaceSync(org.opencastproject.mediapackage.MediaPackage mediaPackage, String channelId, Collection<? extends org.opencastproject.mediapackage.MediaPackageElement> addElements, Set<String> retractElementIds)
    Synchronously replaces media package elements.

  • Field Details

  • Method Details

    • replace

      org.opencastproject.job.api.Job replace(org.opencastproject.mediapackage.MediaPackage mediaPackage, String channelId, Collection<? extends org.opencastproject.mediapackage.MediaPackageElement> addElements, Set<String> retractElementIds) throws PublicationException, org.opencastproject.mediapackage.MediaPackageException
      Replaces media package elements.
      Parameters:
      mediaPackage - the media package
      channelId - the id of the publication channel
      addElements - the media package elements to be added
      retractElementIds - the ids of the media package elements to be removed
      Returns:
      The job
      Throws:
      PublicationException - if there was a problem publishing the media
      org.opencastproject.mediapackage.MediaPackageException - if there was a problem with the mediapackage element

    • replaceSync

      org.opencastproject.mediapackage.Publication replaceSync(org.opencastproject.mediapackage.MediaPackage mediaPackage, String channelId, Collection<? extends org.opencastproject.mediapackage.MediaPackageElement> addElements, Set<String> retractElementIds) throws PublicationException, org.opencastproject.mediapackage.MediaPackageException
      Synchronously replaces media package elements.
      Parameters:
      mediaPackage - the media package
      channelId - the id of the publication channel
      addElements - the media package elements to be added
      retractElementIds - the ids of the media package elements to be removed
      Returns:
      The publication with the updated media package.
      Throws:
      PublicationException - if there was a problem publishing the media
      org.opencastproject.mediapackage.MediaPackageException - if there was a problem with the mediapackage element