org.opensocial.models

Class Album

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

org.opensocial.models.Album

All Implemented Interfaces:

Serializable, Cloneable, Map, org.json.simple.JSONAware, org.json.simple.JSONStreamAware

public class Album
extends Model

OpenSocial model class representing an album, a collection of media items. For reference: http://wiki.opensocial.org/index.php?title=Opensocial.Album_(v0.9) http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/REST-API.html#rfc.section.3.6.1

Author:

Jason Cooper

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Album()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCaption() Returns the album's caption or title.
String	getDescription() Returns the album's description.
String	getId() Returns the album's unique identifier.
String	getOwnerId() Returns the OpenSocial ID of the album's owner.
String	getThumbnailUrl() Returns the album cover's thumbnail URL as a string.
void	setCaption(String caption) Sets the album's caption or title.
void	setDescription(String description) Sets the album's description.
void	setId(String id) Sets the album's unique identifier.
void	setThumbnailUrl(String thumbnailUrl) Sets the album cover's thumbnail URL.

Methods inherited from class org.opensocial.models.Model

addTemplateParameter, addToListField, getField, getFieldAsList, getFieldAsMap, getFieldAsString, getFieldNames, getTemplateParameter, hasField, isFieldMultikeyed, isFieldMultivalued, setField

Methods inherited from class org.json.simple.JSONObject

escape, toJSONString, toJSONString, toString, toString, writeJSONString, writeJSONString

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

Album

public Album()

Method Detail

getId

public String getId()

Returns the album's unique identifier.

getOwnerId

public String getOwnerId()

Returns the OpenSocial ID of the album's owner.

getCaption

public String getCaption()

Returns the album's caption or title.

getDescription

public String getDescription()

Returns the album's description.

getThumbnailUrl

public String getThumbnailUrl()

Returns the album cover's thumbnail URL as a string.

setId

public void setId(String id)

Sets the album's unique identifier. Required when updating an existing album; the container generates the identifier when a new album is created.

Parameters:

id - identifier to set

setCaption

public void setCaption(String caption)

Sets the album's caption or title.

Parameters:

caption - caption to set

setDescription

public void setDescription(String description)

Sets the album's description.

Parameters:

description - description to set

setThumbnailUrl

public void setThumbnailUrl(String thumbnailUrl)

Sets the album cover's thumbnail URL.

Parameters:

thumbnailUrl - URL of album cover thumbnail to set