org.apache.shindig.social.opensocial.spi

Interface MediaItemService

All Known Implementing Classes:

JsonDbOpensocialService, MediaItemService.NotImplementedMediaItemService

public interface MediaItemService

The MediaItemService interface defines the service provider interface for creating, retrieving, updating, and deleting OpenSocial MediaItems.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MediaItemService.NotImplementedMediaItemService

Method Summary

Methods

Modifier and Type	Method and Description
Future<Void>	createMediaItem(UserId userId, String appId, String albumId, MediaItem mediaItem, SecurityToken token)
Future<Void>	deleteMediaItem(UserId userId, String appId, String albumId, String mediaItemId, SecurityToken token)
Future<MediaItem>	getMediaItem(UserId userId, String appId, String albumId, String mediaItemId, Set<String> fields, SecurityToken token)
Future<RestfulCollection<MediaItem>>	getMediaItems(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)
Future<RestfulCollection<MediaItem>>	getMediaItems(UserId userId, String appId, String albumId, Set<String> fields, CollectionOptions options, SecurityToken token)
Future<RestfulCollection<MediaItem>>	getMediaItems(UserId userId, String appId, String albumId, Set<String> mediaItemIds, Set<String> fields, CollectionOptions options, SecurityToken token)
Future<Void>	updateMediaItem(UserId userId, String appId, String albumId, String mediaItemId, MediaItem mediaItem, SecurityToken token)

Method Detail

getMediaItem

Future<MediaItem> getMediaItem(UserId userId,
                             String appId,
                             String albumId,
                             String mediaItemId,
                             Set<String> fields,
                             SecurityToken token)
                               throws ProtocolException

Throws:

ProtocolException

getMediaItems

Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId,
                                                 String appId,
                                                 String albumId,
                                                 Set<String> mediaItemIds,
                                                 Set<String> fields,
                                                 CollectionOptions options,
                                                 SecurityToken token)
                                                   throws ProtocolException

Throws:

ProtocolException

getMediaItems

Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId,
                                                 String appId,
                                                 String albumId,
                                                 Set<String> fields,
                                                 CollectionOptions options,
                                                 SecurityToken token)
                                                   throws ProtocolException

Throws:

ProtocolException

getMediaItems

Future<RestfulCollection<MediaItem>> getMediaItems(Set<UserId> userIds,
                                                 GroupId groupId,
                                                 String appId,
                                                 Set<String> fields,
                                                 CollectionOptions options,
                                                 SecurityToken token)
                                                   throws ProtocolException

Throws:

ProtocolException

deleteMediaItem

Future<Void> deleteMediaItem(UserId userId,
                           String appId,
                           String albumId,
                           String mediaItemId,
                           SecurityToken token)
                             throws ProtocolException

Throws:

ProtocolException

createMediaItem

Future<Void> createMediaItem(UserId userId,
                           String appId,
                           String albumId,
                           MediaItem mediaItem,
                           SecurityToken token)
                             throws ProtocolException

Throws:

ProtocolException

updateMediaItem

Future<Void> updateMediaItem(UserId userId,
                           String appId,
                           String albumId,
                           String mediaItemId,
                           MediaItem mediaItem,
                           SecurityToken token)
                             throws ProtocolException

Throws:

ProtocolException