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

static class

MediaItemService.NotImplementedMediaItemService

Method Summary

java.util.concurrent.Future<java.lang.Void>	createMediaItem(UserId userId, java.lang.String appId, java.lang.String albumId, MediaItem mediaItem, SecurityToken token)
java.util.concurrent.Future<java.lang.Void>	deleteMediaItem(UserId userId, java.lang.String appId, java.lang.String albumId, java.lang.String mediaItemId, SecurityToken token)
java.util.concurrent.Future<MediaItem>	getMediaItem(UserId userId, java.lang.String appId, java.lang.String albumId, java.lang.String mediaItemId, java.util.Set<java.lang.String> fields, SecurityToken token)
java.util.concurrent.Future<RestfulCollection<MediaItem>>	getMediaItems(java.util.Set<UserId> userIds, GroupId groupId, java.lang.String appId, java.util.Set<java.lang.String> fields, CollectionOptions options, SecurityToken token)
java.util.concurrent.Future<RestfulCollection<MediaItem>>	getMediaItems(UserId userId, java.lang.String appId, java.lang.String albumId, java.util.Set<java.lang.String> fields, CollectionOptions options, SecurityToken token)
java.util.concurrent.Future<RestfulCollection<MediaItem>>	getMediaItems(UserId userId, java.lang.String appId, java.lang.String albumId, java.util.Set<java.lang.String> mediaItemIds, java.util.Set<java.lang.String> fields, CollectionOptions options, SecurityToken token)
java.util.concurrent.Future<java.lang.Void>	updateMediaItem(UserId userId, java.lang.String appId, java.lang.String albumId, java.lang.String mediaItemId, MediaItem mediaItem, SecurityToken token)

Method Detail

getMediaItem

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

Throws:

ProtocolException

getMediaItems

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

Throws:

ProtocolException

getMediaItems

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

Throws:

ProtocolException

getMediaItems

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

Throws:

ProtocolException

deleteMediaItem

java.util.concurrent.Future<java.lang.Void> deleteMediaItem(UserId userId,
                                                            java.lang.String appId,
                                                            java.lang.String albumId,
                                                            java.lang.String mediaItemId,
                                                            SecurityToken token)
                                                            throws ProtocolException

Throws:

ProtocolException

createMediaItem

java.util.concurrent.Future<java.lang.Void> createMediaItem(UserId userId,
                                                            java.lang.String appId,
                                                            java.lang.String albumId,
                                                            MediaItem mediaItem,
                                                            SecurityToken token)
                                                            throws ProtocolException

Throws:

ProtocolException

updateMediaItem

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

Throws:

ProtocolException