Package org.opencastproject.lti.service.api

Interface LtiService

public interface LtiService
Interface for implementing functionality available in the LTI GUI

  • Field Details

  • Method Details

    • listJobs

      List<LtiJob> listJobs(String seriesId)
      List currently running jobs for the series
      Parameters:
      seriesId - ID of the series
      Returns:
      A list of jobs

    • upsertEvent

      void upsertEvent(LtiFileUpload file, String captions, String captionFormat, String captionLanguage, String eventId, String seriesId, String metadataJson) throws org.opencastproject.security.api.UnauthorizedException, org.opencastproject.util.NotFoundException
      Upload a new event or update existing event's metadata
      Parameters:
      file - File to upload
      captions - Subtitles file
      eventId - ID of the event (can be null for new events)
      seriesId - ID of the series
      metadataJson - Metadata for the event as JSON string
      Throws:
      org.opencastproject.security.api.UnauthorizedException
      org.opencastproject.util.NotFoundException

    • copyEventToSeries

      void copyEventToSeries(String eventId, String seriesId)
      Copy an event to a different series
      Parameters:
      eventId - Event ID to copy
      seriesId - Series ID to copy into

    • getEventMetadata

      String getEventMetadata(String eventId) throws org.opencastproject.util.NotFoundException, org.opencastproject.security.api.UnauthorizedException
      Returns the event metadata for a specific event
      Parameters:
      eventId - ID of the event
      Returns:
      The event metadata list
      Throws:
      org.opencastproject.util.NotFoundException - If the event doesn't exist
      org.opencastproject.security.api.UnauthorizedException - If the user cannot access the event

    • getNewEventMetadata

      String getNewEventMetadata()
      Returns the event metadata for a new event
      Returns:
      The event metadata list

    • setEventMetadataJson

      void setEventMetadataJson(String eventId, String metadataJson) throws org.opencastproject.util.NotFoundException, org.opencastproject.security.api.UnauthorizedException
      Set the event metadata
      Parameters:
      eventId - ID of the event
      metadataJson - New metadata of the event as JSON
      Throws:
      org.opencastproject.util.NotFoundException - If the event doesn't exist
      org.opencastproject.security.api.UnauthorizedException - If the user cannot access the event

    • delete

      void delete(String eventId)
      Deletes the specified event
      Parameters:
      eventId - ID of the event