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

static class

AlbumService.NotImplementedAlbumService

Method Summary

java.util.concurrent.Future<java.lang.Void>	createAlbum(UserId userId, java.lang.String appId, Album album, SecurityToken token)
java.util.concurrent.Future<java.lang.Void>	deleteAlbum(UserId userId, java.lang.String appId, java.lang.String albumId, SecurityToken token)
java.util.concurrent.Future<Album>	getAlbum(UserId userId, java.lang.String appId, java.util.Set<java.lang.String> fields, java.lang.String albumId, SecurityToken token)
java.util.concurrent.Future<RestfulCollection<Album>>	getAlbums(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<Album>>	getAlbums(UserId userId, java.lang.String appId, java.util.Set<java.lang.String> fields, CollectionOptions options, java.util.Set<java.lang.String> albumIds, SecurityToken token)
java.util.concurrent.Future<java.lang.Void>	updateAlbum(UserId userId, java.lang.String appId, Album album, java.lang.String albumId, SecurityToken token)

Method Detail

getAlbum

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

Throws:

ProtocolException

getAlbums

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

Throws:

ProtocolException

getAlbums

java.util.concurrent.Future<RestfulCollection<Album>> getAlbums(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

deleteAlbum

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

Throws:

ProtocolException

createAlbum

java.util.concurrent.Future<java.lang.Void> createAlbum(UserId userId,
                                                        java.lang.String appId,
                                                        Album album,
                                                        SecurityToken token)
                                                        throws ProtocolException

Throws:

ProtocolException

updateAlbum

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

Throws:

ProtocolException