org.atlasapi.schedule

Interface ScheduleWriter

All Known Subinterfaces:

ScheduleStore

All Known Implementing Classes:

AbstractScheduleStore

public interface ScheduleWriter

A ScheduleWriter is responsible for persisting Items and their related Content hierarchies in a manner suitable for later resolution in Schedule form by Channel and Interval via a ScheduleResolver.

Method Summary

Methods

Modifier and Type	Method and Description
List<WriteResult<? extends Content>>	writeSchedule(List<ScheduleHierarchy> items, org.atlasapi.media.channel.Channel channel, org.joda.time.Interval interval) Write a schedule of Items.

Method Detail

writeSchedule

List<WriteResult<? extends Content>> writeSchedule(List<ScheduleHierarchy> items,
                                                 org.atlasapi.media.channel.Channel channel,
                                                 org.joda.time.Interval interval)
                                                   throws WriteException

Write a schedule of Items. The Items are presented in a hierarchy along with their Containers. Each Item must have a Broadcast on the provided Channel within the provided Interval. The Hierarchies must be ordered such that the relevant Broadcasts are contiguous. All the Content must be from the same Source. All Content must be persisted to a ContentStore. A ScheduleWriter is also responsible for maintaining Broadcast "actively published" flag status in the ContentStore.

Parameters:

items - - an list of ScheduleHierarchys ordered by Broadcast transmission start time.

channel - - the channel for which the schedule is to be written.

interval - - the interval for which the schedule is provided.

Returns:

write results for every piece of Content written from the hierarchies.

Throws:

WriteException - if the write is not successfully performed.

IllegalArgumentException - if the presented schedule is not contiguous or the content is not source-homogenous