Package org.opencastproject.playlists.persistence

Interface PlaylistDatabaseService

All Known Implementing Classes:

PlaylistDatabaseServiceImpl

public interface PlaylistDatabaseService

API that defines persistent storage of playlists

Method Summary

Modifier and Type	Method	Description
Playlist	deletePlaylist(Playlist playlist, String orgId)	Removes a single playlist.
List<Playlist>	getAllForAdministrativeRead(Date from, Date endDate, int limit)
Playlist	getPlaylist(String playlistId)	Gets a single playlist in the current organization context by its identifier.
Playlist	getPlaylist(String playlistId, String orgId)	Gets a single playlist by its identifier.
List<Playlist>	getPlaylists(int limit, int offset, SortCriterion sortCriterion)	Get several playlists based on their order in the database
Playlist	updatePlaylist(Playlist playlist, String orgId)	Creates or updates a single playlist.

Method Details

getPlaylist

Playlist getPlaylist(String playlistId)
              throws NotFoundException,
PlaylistDatabaseException

Gets a single playlist in the current organization context by its identifier.

Parameters:

playlistId - the playlist identifier

Returns:

the Playlist with the given identifier

Throws:

NotFoundException - if there is no playlist with this identifier

PlaylistDatabaseException - if there is a problem communicating with the underlying data store

getPlaylist

Playlist getPlaylist(String playlistId,
 String orgId)
              throws NotFoundException,
PlaylistDatabaseException

Gets a single playlist by its identifier.

Parameters:

playlistId - the playlist identifier

orgId - the organisation identifier

Returns:

the Playlist with the given identifier

Throws:

NotFoundException - if there is no playlist with this identifier

PlaylistDatabaseException - if there is a problem communicating with the underlying data store

getPlaylists

List<Playlist> getPlaylists(int limit,
 int offset,
 SortCriterion sortCriterion)
                     throws PlaylistDatabaseException

Get several playlists based on their order in the database

Parameters:

limit - Maximum amount of playlists to return

offset - The index of the first result to return

Returns:

a list of Playlists

Throws:

PlaylistDatabaseException - if there is a problem communicating with the underlying data store

getAllForAdministrativeRead

List<Playlist> getAllForAdministrativeRead(Date from,
 Date endDate,
 int limit)
                                    throws PlaylistDatabaseException

Throws:

PlaylistDatabaseException

updatePlaylist

Playlist updatePlaylist(Playlist playlist,
 String orgId)
                 throws PlaylistDatabaseException

Creates or updates a single playlist.

Parameters:

playlist - The Playlist

Returns:

The updated Playlist

Throws:

PlaylistDatabaseException - if there is a problem communicating with the underlying data store

deletePlaylist

Playlist deletePlaylist(Playlist playlist,
 String orgId)
                 throws PlaylistDatabaseException

Removes a single playlist.

Parameters:

playlist - The Playlist

Returns:

The deleted Playlist

Throws:

PlaylistDatabaseException - if there is a problem communicating with the underlying data store