org.apache.shindig.social.opensocial.spi

Class AlbumService.NotImplementedAlbumService

java.lang.Object

org.apache.shindig.social.opensocial.spi.AlbumService.NotImplementedAlbumService

All Implemented Interfaces:

AlbumService

Enclosing interface:

AlbumService

public static class AlbumService.NotImplementedAlbumService
extends Object
implements AlbumService

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.AlbumService

AlbumService.NotImplementedAlbumService

Constructor Summary

Constructors

Constructor and Description
AlbumService.NotImplementedAlbumService()

Method Summary

Methods

Modifier and Type	Method and Description
Future<Void>	createAlbum(UserId userId, String appId, Album album, SecurityToken token) Creates an album for the given user.
Future<Void>	deleteAlbum(UserId userId, String appId, String albumId, SecurityToken token) Deletes a single album for the given user with the given album ID.
Future<Album>	getAlbum(UserId userId, String appId, Set<String> fields, String albumId, SecurityToken token) Retrieves a single album for the given user with the given album ID.
Future<RestfulCollection<Album>>	getAlbums(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token) Retrieves albums for the given user and group.
Future<RestfulCollection<Album>>	getAlbums(UserId userId, String appId, Set<String> fields, CollectionOptions options, Set<String> albumIds, SecurityToken token) Retrieves albums for the given user with the given album IDs.
Future<Void>	updateAlbum(UserId userId, String appId, Album album, String albumId, SecurityToken token) Updates an album for the given user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlbumService.NotImplementedAlbumService

public AlbumService.NotImplementedAlbumService()

Method Detail

getAlbum

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

Description copied from interface: AlbumService

Retrieves a single album for the given user with the given album ID.

Specified by:

getAlbum in interface AlbumService

Parameters:

userId - Identifies the person to retrieve the album from

appId - Identifies the application to retrieve the album from

fields - Indicates the fields to return. Empty set implies all

albumId - Identifies the album to retrieve

token - A valid SecurityToken

Returns:

a response item with the requested album

Throws:

ProtocolException

getAlbums

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

Description copied from interface: AlbumService

Retrieves albums for the given user with the given album IDs.

Specified by:

getAlbums in interface AlbumService

Parameters:

userId - Identifies the person to retrieve albums for

appId - Identifies the application to retrieve albums from

fields - The fields to return; empty set implies all

options - The sorting/filtering/pagination options

albumIds - The set of album ids to fetch

token - A valid SecurityToken

Returns:

a response item with requested albums

Throws:

ProtocolException

getAlbums

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

Description copied from interface: AlbumService

Retrieves albums for the given user and group.

Specified by:

getAlbums in interface AlbumService

Parameters:

userIds - Identifies the users to retrieve albums from

groupId - Identifies the group to retrieve albums from

appId - Identifies the application to retrieve albums from

fields - The fields to return. Empty set implies all

options - The sorting/filtering/pagination options

token - A valid SecurityToken

Returns:

a response item with the requested albums

Throws:

ProtocolException

deleteAlbum

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

Description copied from interface: AlbumService

Deletes a single album for the given user with the given album ID.

Specified by:

deleteAlbum in interface AlbumService

Parameters:

userId - Identifies the user to delete the album from

appId - Identifies the application to delete the album from

albumId - Identifies the album to delete

token - A valid SecurityToken

Returns:

a response item containing any errors

Throws:

ProtocolException

createAlbum

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

Description copied from interface: AlbumService

Creates an album for the given user.

Specified by:

createAlbum in interface AlbumService

Parameters:

userId - Identifies the user to create the album for

appId - Identifies the application to create the album in

album - The album to create

token - A valid SecurityToken

Returns:

a response containing any errors

Throws:

ProtocolException

updateAlbum

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

Description copied from interface: AlbumService

Updates an album for the given user. The album ID specified in the REST end-point is used, even if the album also defines an ID.

Specified by:

updateAlbum in interface AlbumService

Parameters:

userId - Identifies the user to update the album for

appId - Identifies the application to update the album in

album - Defines the updated album

albumId - Identifies the ID of the album to update

token - A valid SecurityToken

Returns:

a response containing any errors

Throws:

ProtocolException