Package org.opencastproject.message.broker.api.scheduler

Class SchedulerItem

java.lang.Object
org.opencastproject.message.broker.api.scheduler.SchedulerItem
All Implemented Interfaces:
Serializable
public class SchedulerItem extends Object implements Serializable
Serializable class that represents all of the possible messages sent through a SchedulerService queue.
See Also:

  • Constructor Details

    • SchedulerItem

      public SchedulerItem(org.opencastproject.metadata.dublincore.DublinCoreCatalog event)
      Constructor to build an update event SchedulerItem.
      Parameters:
      event - The event details to update.

    • SchedulerItem

      public SchedulerItem(Map<String,String> properties)
      Constructor to build an update properties for an event SchedulerItem.
      Parameters:
      properties - The properties to update.

    • SchedulerItem

      public SchedulerItem(SchedulerItem.Type type)
      Constructor to build a delete event SchedulerItem.

    • SchedulerItem

      public SchedulerItem(org.opencastproject.security.api.AccessControlList accessControlList)
      Constructor to build an update access control list event SchedulerItem.
      Parameters:
      accessControlList - The access control list

    • SchedulerItem

      public SchedulerItem(String state, Long lastHeardFrom)
      Constructor to build an update recording status event SchedulerItem.
      Parameters:
      state - the recording status
      lastHeardFrom - the last heard from time

    • SchedulerItem

      public SchedulerItem(Date start, Date end, SchedulerItem.Type type)

    • SchedulerItem

      public SchedulerItem(String agentId)

    • SchedulerItem

      public SchedulerItem(Set<String> presenters)

  • Method Details

    • updateCatalog

      public static SchedulerItem updateCatalog(org.opencastproject.metadata.dublincore.DublinCoreCatalog event)
      Parameters:
      event - The event details to update to.
      Returns:
      Builds SchedulerItem for updating a scheduled event.

    • updateProperties

      public static SchedulerItem updateProperties(Map<String,String> properties)
      Parameters:
      properties - The new properties to update to.
      Returns:
      Builds SchedulerItem for updating the properties of an event.

    • delete

      public static SchedulerItem delete()
      Returns:
      Builds SchedulerItem for deleting an event.

    • updateAcl

      public static SchedulerItem updateAcl(org.opencastproject.security.api.AccessControlList accessControlList)
      Parameters:
      accessControlList - the access control list
      Returns:
      Builds SchedulerItem for updating the access control list of an event.

    • updateRecordingStatus

      public static SchedulerItem updateRecordingStatus(String state, Long lastHeardFrom)
      Parameters:
      state - The recording state
      lastHeardFrom - The recording last heard from date
      Returns:
      Builds SchedulerItem for updating a recording.

    • updateStart

      public static SchedulerItem updateStart(Date start)
      Parameters:
      start - The new start time for the event.
      Returns:
      Builds SchedulerItem for updating the start of an event.

    • updateEnd

      public static SchedulerItem updateEnd(Date end)
      Parameters:
      end - The new end time for the event.
      Returns:
      Builds SchedulerItem for updating the end of an event.

    • updatePresenters

      public static SchedulerItem updatePresenters(Set<String> presenters)
      Parameters:
      presenters - The new set of presenters for the event.
      Returns:
      Builds SchedulerItem for updating the presenters of an event.

    • updateAgent

      public static SchedulerItem updateAgent(String agentId)
      Parameters:
      agentId - The new agent id for the event.
      Returns:
      Builds SchedulerItem for updating the agent id of an event.

    • deleteRecordingState

      public static SchedulerItem deleteRecordingState()
      Returns:
      Builds SchedulerItem for deleting a recording.

    • getEvent

      public org.opencastproject.metadata.dublincore.DublinCoreCatalog getEvent()

    • getProperties

      public Map<String,String> getProperties()

    • getAcl

      public org.opencastproject.security.api.AccessControlList getAcl()

    • getAgentId

      public String getAgentId()

    • getEnd

      public Date getEnd()

    • getPresenters

      public Set<String> getPresenters()

    • getRecordingState

      public String getRecordingState()

    • getStart

      public Date getStart()

    • getType

      public SchedulerItem.Type getType()