Author: ssievers
Date: Tue Nov 19 12:43:39 2013
New Revision: 1543404
URL: http://svn.apache.org/r1543404
Log:
SHINDIG-1954 | Use proper javadoc comments for AlbumService and
MediaItemService interfaces | Patch from Andreas Kohn. Thanks!
Modified:
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java
Modified:
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java
URL:
http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java?rev=1543404&r1=1543403&r2=1543404&view=diff
==============================================================================
---
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java
(original)
+++
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java
Tue Nov 19 12:43:39 2013
@@ -38,91 +38,91 @@ import javax.servlet.http.HttpServletRes
@ImplementedBy(AlbumService.NotImplementedAlbumService.class)
public interface AlbumService {
- /*
- * Retrieves a single album for the given user with the given album ID.
- *
- * @param userId Identifies the person to retrieve the album from
- * @param appId Identifies the application to retrieve the album from
- * @param fields Indicates the fields to return. Empty set implies all
- * @param albumId Identifies the album to retrieve
- * @param token A valid SecurityToken
- *
- * @return a response item with the requested album
- */
+ /**
+ * Retrieves a single album for the given user with the given album ID.
+ *
+ * @param userId Identifies the person to retrieve the album from
+ * @param appId Identifies the application to retrieve the album from
+ * @param fields Indicates the fields to return. Empty set implies all
+ * @param albumId Identifies the album to retrieve
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with the requested album
+ */
Future<Album> getAlbum(UserId userId, String appId, Set<String> fields,
String albumId, SecurityToken token) throws
ProtocolException;
- /*
- * Retrieves albums for the given user with the given album IDs.
- *
- * @param userId Identifies the person to retrieve albums for
- * @param appId Identifies the application to retrieve albums from
- * @param fields The fields to return; empty set implies all
- * @param options The sorting/filtering/pagination options
- * @param albumIds The set of album ids to fetch
- * @param token A valid SecurityToken
- *
- * @return a response item with requested albums
- */
+ /**
+ * Retrieves albums for the given user with the given album IDs.
+ *
+ * @param userId Identifies the person to retrieve albums for
+ * @param appId Identifies the application to retrieve albums from
+ * @param fields The fields to return; empty set implies all
+ * @param options The sorting/filtering/pagination options
+ * @param albumIds The set of album ids to fetch
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with requested albums
+ */
Future<RestfulCollection<Album>> getAlbums(UserId userId, String appId,
Set<String> fields,
CollectionOptions options,
Set<String> albumIds,
SecurityToken token) throws ProtocolException;
- /*
- * Retrieves albums for the given user and group.
- *
- * @param userIds Identifies the users to retrieve albums from
- * @param groupId Identifies the group to retrieve albums from
- * @param appId Identifies the application to retrieve albums from
- * @param fields The fields to return. Empty set implies all
- * @param options The sorting/filtering/pagination options
- * @param token A valid SecurityToken
- *
- * @return a response item with the requested albums
- */
+ /**
+ * Retrieves albums for the given user and group.
+ *
+ * @param userIds Identifies the users to retrieve albums from
+ * @param groupId Identifies the group to retrieve albums from
+ * @param appId Identifies the application to retrieve albums from
+ * @param fields The fields to return. Empty set implies all
+ * @param options The sorting/filtering/pagination options
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with the requested albums
+ */
Future<RestfulCollection<Album>> getAlbums(Set<UserId> userIds,
GroupId groupId, String appId,
Set<String> fields,
CollectionOptions options,
SecurityToken token)
throws ProtocolException;
- /*
- * Deletes a single album for the given user with the given album ID.
- *
- * @param userId Identifies the user to delete the album from
- * @param appId Identifies the application to delete the album from
- * @param albumId Identifies the album to delete
- * @param token A valid SecurityToken
- *
- * @return a response item containing any errors
- */
+ /**
+ * Deletes a single album for the given user with the given album ID.
+ *
+ * @param userId Identifies the user to delete the album from
+ * @param appId Identifies the application to delete the album from
+ * @param albumId Identifies the album to delete
+ * @param token A valid SecurityToken
+ *
+ * @return a response item containing any errors
+ */
Future<Void> deleteAlbum(UserId userId, String appId, String albumId,
SecurityToken token) throws ProtocolException;
- /*
- * Creates an album for the given user.
- *
- * @param userId Identifies the user to create the album for
- * @param appId Identifies the application to create the album in
- * @param album The album to create
- * @param token A valid SecurityToken
- *
- * @return a response containing any errors
- */
+ /**
+ * Creates an album for the given user.
+ *
+ * @param userId Identifies the user to create the album for
+ * @param appId Identifies the application to create the album in
+ * @param album The album to create
+ * @param token A valid SecurityToken
+ *
+ * @return a response containing any errors
+ */
Future<Void> createAlbum(UserId userId, String appId, Album album,
SecurityToken token) throws ProtocolException;
- /*
- * 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.
- *
- * @param userId Identifies the user to update the album for
- * @param appId Identifies the application to update the album in
- * @param album Defines the updated album
- * @param albumId Identifies the ID of the album to update
- * @param token A valid SecurityToken
- *
- * @return a response containing any errors
- */
+ /**
+ * 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.
+ *
+ * @param userId Identifies the user to update the album for
+ * @param appId Identifies the application to update the album in
+ * @param album Defines the updated album
+ * @param albumId Identifies the ID of the album to update
+ * @param token A valid SecurityToken
+ *
+ * @return a response containing any errors
+ */
Future<Void> updateAlbum(UserId userId, String appId, Album album,
String albumId, SecurityToken token) throws
ProtocolException;
Modified:
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java
URL:
http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java?rev=1543404&r1=1543403&r2=1543404&view=diff
==============================================================================
---
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java
(original)
+++
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java
Tue Nov 19 12:43:39 2013
@@ -36,115 +36,115 @@ import javax.servlet.http.HttpServletRes
*/
public interface MediaItemService {
- /*
- * Retrieves a MediaItem by ID.
- *
- * @param userId Identifies the owner of the MediaItem to retrieve
- * @param appId Identifies the application of the MeiaItem to retrieve
- * @param albumId Identifies the album containing the MediaItem
- * @param mediaItemId Identifies the MediaItem to retrieve
- * @param fields Indicates fields to be returned; empty set implies all
- * @param token A valid SecurityToken
- *
- * @return a response item with the requested MediaItem
- */
+ /**
+ * Retrieves a MediaItem by ID.
+ *
+ * @param userId Identifies the owner of the MediaItem to retrieve
+ * @param appId Identifies the application of the MeiaItem to retrieve
+ * @param albumId Identifies the album containing the MediaItem
+ * @param mediaItemId Identifies the MediaItem to retrieve
+ * @param fields Indicates fields to be returned; empty set implies all
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with the requested MediaItem
+ */
Future<MediaItem> getMediaItem(UserId userId, String appId, String albumId,
String mediaItemId, Set<String> fields,
SecurityToken token)
throws ProtocolException;
- /*
- * Retrieves MediaItems by IDs.
- *
- * @param userId Identifies the owner of the MediaItems
- * @param appId Identifies the application of the MediaItems
- * @param albumId Identifies the album containing the MediaItems
- * @param mediaItemIds Identifies the MediaItems to retrieve
- * @param fields Specifies the fields to return; empty set implies all
- * @param options Sorting/filtering/pagination options
- * @param token A valid SecurityToken
- *
- * @return a response item with the requested MediaItems
- */
+ /**
+ * Retrieves MediaItems by IDs.
+ *
+ * @param userId Identifies the owner of the MediaItems
+ * @param appId Identifies the application of the MediaItems
+ * @param albumId Identifies the album containing the MediaItems
+ * @param mediaItemIds Identifies the MediaItems to retrieve
+ * @param fields Specifies the fields to return; empty set implies all
+ * @param options Sorting/filtering/pagination options
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with the requested MediaItems
+ */
Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId,
String appId, String
albumId, Set<String> mediaItemIds,
Set<String> fields,
CollectionOptions options, SecurityToken token)
throws ProtocolException;
- /*
- * Retrieves MediaItems by Album.
- *
- * @param userId Identifies the owner of the MediaItems
- * @param appId Identifies the application of the MediaItems
- * @param albumId Identifies the Album containing the MediaItems
- * @param fields Specifies the fields to return; empty set implies all
- * @param options Sorting/filtering/pagination options
- * @param token A valid SecurityToken
- *
- * @return a response item with the requested MediaItems
- */
+ /**
+ * Retrieves MediaItems by Album.
+ *
+ * @param userId Identifies the owner of the MediaItems
+ * @param appId Identifies the application of the MediaItems
+ * @param albumId Identifies the Album containing the MediaItems
+ * @param fields Specifies the fields to return; empty set implies all
+ * @param options Sorting/filtering/pagination options
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with the requested MediaItems
+ */
Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId,
String appId, String
albumId, Set<String> fields,
CollectionOptions
options, SecurityToken token)
throws ProtocolException;
- /*
- * Retrieves MediaItems by users and groups.
- *
- * @param userIds Identifies the users that this request is relative to
- * @param groupId Identifies the users' groups to retrieve MediaItems from
- * @param appId Identifies the application to retrieve MediaItems from
- * @param fields The fields to return; empty set implies all
- * @param options Sorting/filtering/pagination options
- * @param token A valid SecurityToken
- *
- * @return a response item with the requested MediaItems
- */
+ /**
+ * Retrieves MediaItems by users and groups.
+ *
+ * @param userIds Identifies the users that this request is relative to
+ * @param groupId Identifies the users' groups to retrieve MediaItems from
+ * @param appId Identifies the application to retrieve MediaItems from
+ * @param fields The fields to return; empty set implies all
+ * @param options Sorting/filtering/pagination options
+ * @param token A valid SecurityToken
+ *
+ * @return a response item with the requested MediaItems
+ */
Future<RestfulCollection<MediaItem>> getMediaItems(Set<UserId> userIds,
GroupId groupId, String
appId, Set<String> fields,
CollectionOptions
options, SecurityToken token)
throws ProtocolException;
- /*
- * Deletes a MediaItem by ID.
- *
- * @param userId Identifies the owner of the MediaItem to delete
- * @param appId Identifies the application hosting the MediaItem
- * @param albumId Identifies the parent album of the MediaItem
- * @param mediaItemId Identifies the MediaItem to delete
- * @param token A valid SecurityToken
- *
- * @return a response item containing any errors
- */
+ /**
+ * Deletes a MediaItem by ID.
+ *
+ * @param userId Identifies the owner of the MediaItem to delete
+ * @param appId Identifies the application hosting the MediaItem
+ * @param albumId Identifies the parent album of the MediaItem
+ * @param mediaItemId Identifies the MediaItem to delete
+ * @param token A valid SecurityToken
+ *
+ * @return a response item containing any errors
+ */
Future<Void> deleteMediaItem(UserId userId, String appId, String albumId,
String mediaItemId, SecurityToken token) throws
ProtocolException;
- /*
- * Create a MediaItem in the given album for the given user.
- *
- * @param userId Identifies the owner of the MediaItem to create
- * @param appId Identifies the application hosting the MediaItem
- * @param albumId Identifies the album to contain the MediaItem
- * @param mediaItem The MediaItem to create
- * @param token A valid SecurityToken
- *
- * @return a response containing any errors
- */
+ /**
+ * Create a MediaItem in the given album for the given user.
+ *
+ * @param userId Identifies the owner of the MediaItem to create
+ * @param appId Identifies the application hosting the MediaItem
+ * @param albumId Identifies the album to contain the MediaItem
+ * @param mediaItem The MediaItem to create
+ * @param token A valid SecurityToken
+ *
+ * @return a response containing any errors
+ */
Future<Void> createMediaItem(UserId userId, String appId, String albumId,
MediaItem mediaItem, SecurityToken token)
throws ProtocolException;
- /*
- * Updates a MediaItem for the given user. The MediaItem ID specified in
- * the REST end-point is used, even if the MediaItem also defines an ID.
- *
- * @param userId Identifies the owner of the MediaItem to update
- * @param appId Identifies the application hosting the MediaItem
- * @param albumId Identifies the album containing the MediaItem
- * @param mediaItemId Identifies the MediaItem to update
- * @param mediaItem The updated MediaItem to persist
- * @param token A valid SecurityToken
- *
- * @return a response containing any errors
- */
+ /**
+ * Updates a MediaItem for the given user. The MediaItem ID specified in
+ * the REST end-point is used, even if the MediaItem also defines an ID.
+ *
+ * @param userId Identifies the owner of the MediaItem to update
+ * @param appId Identifies the application hosting the MediaItem
+ * @param albumId Identifies the album containing the MediaItem
+ * @param mediaItemId Identifies the MediaItem to update
+ * @param mediaItem The updated MediaItem to persist
+ * @param token A valid SecurityToken
+ *
+ * @return a response containing any errors
+ */
Future<Void> updateMediaItem(UserId userId, String appId, String albumId,
String mediaItemId, MediaItem mediaItem,
SecurityToken token)
throws ProtocolException;
