org.apache.shindig.social.opensocial.spi

Interface AlbumService

All Known Implementing Classes:

AlbumService.NotImplementedAlbumService, JsonDbOpensocialService

public interface AlbumService

The AlbumService interface defines the service provider interface for creating, retrieving, updating, and deleting OpenSocial albums.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AlbumService.NotImplementedAlbumService

Method Summary

Methods

Modifier and Type	Method and Description
Future<Void>	createAlbum(UserId userId, String appId, Album album, SecurityToken token)
Future<Void>	deleteAlbum(UserId userId, String appId, String albumId, SecurityToken token)
Future<Album>	getAlbum(UserId userId, String appId, Set<String> fields, String albumId, SecurityToken token)
Future<RestfulCollection<Album>>	getAlbums(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)
Future<RestfulCollection<Album>>	getAlbums(UserId userId, String appId, Set<String> fields, CollectionOptions options, Set<String> albumIds, SecurityToken token)
Future<Void>	updateAlbum(UserId userId, String appId, Album album, String albumId, SecurityToken token)

Method Detail

getAlbum

Future<Album> getAlbum(UserId userId,
                     String appId,
                     Set<String> fields,
                     String albumId,
                     SecurityToken token)
                       throws ProtocolException

Throws:

ProtocolException

getAlbums

Future<RestfulCollection<Album>> getAlbums(UserId userId,
                                         String appId,
                                         Set<String> fields,
                                         CollectionOptions options,
                                         Set<String> albumIds,
                                         SecurityToken token)
                                           throws ProtocolException

Throws:

ProtocolException

getAlbums

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

Throws:

ProtocolException

deleteAlbum

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

Throws:

ProtocolException

createAlbum

Future<Void> createAlbum(UserId userId,
                       String appId,
                       Album album,
                       SecurityToken token)
                         throws ProtocolException

Throws:

ProtocolException

updateAlbum

Future<Void> updateAlbum(UserId userId,
                       String appId,
                       Album album,
                       String albumId,
                       SecurityToken token)
                         throws ProtocolException

Throws:

ProtocolException