org.apache.shindig.social.opensocial.model

Interface Album

All Known Implementing Classes:

AlbumImpl

public interface Album

The Album API describes the collection of MediaItems of images, movies, and audio.

Please see http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/OpenSocial-Specification.html#opensocial.Album.Field for details about the supported fields.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Album.Field The fields that represent the Album object in json form.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Get a string specifying the description of this album.
String	getId() Get a string ID specifying the unique identifier of this album.
Address	getLocation() Get address location of this album.
Integer	getMediaItemCount() Get the number of items in the album.
List<String>	getMediaMimeType() Get the identifying mime-types of the items in the album.
List<MediaItem.Type>	getMediaType() Get the list of media item types for the items in the album.
String	getOwnerId() Get the ID of the owner of the album.
String	getThumbnailUrl() Get the URL to the thumbnail cover image for the album.
String	getTitle() Get the title of the album.
void	setDescription(String description) Set the description of this album.
void	setId(String id) Set a string ID specifying a unique identifier of this album.
void	setLocation(Address location) Set the address location of this album.
void	setMediaItemCount(Integer mediaItemCount) Set the number of items in the album.
void	setMediaMimeType(List<String> mediaMimeType) Set the identifying mime-types of the items in the album.
void	setMediaType(List<MediaItem.Type> mediaType) Set the list of media item types for the items in the album.
void	setOwnerId(String ownerId) Set the string ID of the owner of the album.
void	setThumbnailUrl(String thumbnailUrl) Set the URL of the thumbnail cover image for the album.
void	setTitle(String title) Set the title of the album.

Method Detail

getDescription

String getDescription()

Get a string specifying the description of this album.

Returns:

a string specifying the description of this album.

setDescription

void setDescription(String description)

Set the description of this album.

Parameters:

description - a string specifying the description of this album.

getId

String getId()

Get a string ID specifying the unique identifier of this album.

Returns:

a string ID specifying the unique identifier of this album.

setId

void setId(String id)

Set a string ID specifying a unique identifier of this album.

Parameters:

id - a string ID specifying the unique identifier of this album.

getLocation

Address getLocation()

Get address location of this album.

Returns:

an Address specifying the location of this album.

setLocation

void setLocation(Address location)

Set the address location of this album.

Parameters:

location - an Address specifying the location of this album.

getMediaItemCount

Integer getMediaItemCount()

Get the number of items in the album.

Returns:

an integer specifying the number of items in the album

setMediaItemCount

void setMediaItemCount(Integer mediaItemCount)

Set the number of items in the album.

Parameters:

mediaItemCount - an integer specifying the number of items in the album.

getMediaMimeType

List<String> getMediaMimeType()

Get the identifying mime-types of the items in the album.

Returns:

a List of strings specifying the mime-types of the items in the album.

setMediaMimeType

void setMediaMimeType(List<String> mediaMimeType)

Set the identifying mime-types of the items in the album.

Parameters:

mediaMimeType - a List of strings specifying the mime-types of the items in the album.

getMediaType

List<MediaItem.Type> getMediaType()

Get the list of media item types for the items in the album.

Returns:

a List of MediaItem.Type specifying the media item types for items in the album.

setMediaType

void setMediaType(List<MediaItem.Type> mediaType)

Set the list of media item types for the items in the album.

Parameters:

mediaType - List of MediaItem.Type specifying media item types for items in the album.

getOwnerId

String getOwnerId()

Get the ID of the owner of the album.

Returns:

a string identifying the ID of the owner of the album.

setOwnerId

void setOwnerId(String ownerId)

Set the string ID of the owner of the album.

Parameters:

ownerId - a string ID that identify the owner of the album.

getThumbnailUrl

String getThumbnailUrl()

Get the URL to the thumbnail cover image for the album.

Returns:

a string specifying the URL for thumbnail cover image of the album.

setThumbnailUrl

void setThumbnailUrl(String thumbnailUrl)

Set the URL of the thumbnail cover image for the album.

Parameters:

thumbnailUrl - a string specifying the URL for thumbnail cover image of the album.

getTitle

String getTitle()

Get the title of the album.

Returns:

a string specifying the tile of the album.

setTitle

void setTitle(String title)

Set the title of the album.

Parameters:

title - a string specifying the title of the album.