org.opensocial.models

Class MediaItem

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

org.opensocial.models.MediaItem

All Implemented Interfaces:

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

public class MediaItem
extends Model

OpenSocial model class representing a media item (image, movie, or audio). For reference: http://wiki.opensocial.org/index.php?title=Opensocial.MediaItem_(v0.9) http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/REST-API.html#rfc.section.3.6.2

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>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALBUM_ID
static String	CAPTION
static String	DESCRIPTION
static String	ID
static String	MIME_TYPE
static String	THUMBNAIL_URL
static String	TYPE
static String	URL

Constructor Summary

Constructors

Constructor and Description
MediaItem()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlbumId() Returns the identifier of the album to which the media item belongs.
String	getCaption() Returns the media item's caption if set.
String	getDescription() Returns the media item's description if set.
String	getId() Returns the media item's associated ID.
String	getMimeType() Returns the MIME type of the media item's content.
String	getThumbnailUrl() Returns the URL of the media item's thumbnail image as a string.
String	getType() Returns the media item's type, one of 'audio', 'image', or 'video'.
String	getUrl() Returns the URL where the media can be found as a string.
void	setAlbumId(String albumId) Sets the identifier of the album to which the media item belongs.
void	setCaption(String caption) Sets the media item's caption/title.
void	setDescription(String description) Sets the media item's description.
void	setId(String id) Sets the media item's unique identifier.
void	setMimeType(String mimeType) Sets the MIME type of the media item's content.
void	setThumbnailUrl(String thumbnailUrl) Sets the URL of the media item's thumbnail image as a string.
void	setType(String type) Sets the media item's type.
void	setUrl(String url) Sets the URL where the media can be found.

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

URL

public static final String URL

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

CAPTION

public static final String CAPTION

See Also:

Constant Field Values

ALBUM_ID

public static final String ALBUM_ID

See Also:

Constant Field Values

MIME_TYPE

public static final String MIME_TYPE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

THUMBNAIL_URL

public static final String THUMBNAIL_URL

See Also:

Constant Field Values

Constructor Detail

MediaItem

public MediaItem()

Method Detail

getId

public String getId()

Returns the media item's associated ID.

getAlbumId

public String getAlbumId()

Returns the identifier of the album to which the media item belongs.

getUrl

public String getUrl()

Returns the URL where the media can be found as a string.

getThumbnailUrl

public String getThumbnailUrl()

Returns the URL of the media item's thumbnail image as a string.

getType

public String getType()

Returns the media item's type, one of 'audio', 'image', or 'video'.

getMimeType

public String getMimeType()

Returns the MIME type of the media item's content.

getCaption

public String getCaption()

Returns the media item's caption if set.

getDescription

public String getDescription()

Returns the media item's description if set.

setId

public void setId(String id)

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

Parameters:

id - identifier to set

setAlbumId

public void setAlbumId(String albumId)

Sets the identifier of the album to which the media item belongs.

Parameters:

albumId - ID of album intended to contain media item

setUrl

public void setUrl(String url)

Sets the URL where the media can be found.

Parameters:

url - URL to set

setThumbnailUrl

public void setThumbnailUrl(String thumbnailUrl)

Sets the URL of the media item's thumbnail image as a string.

Parameters:

thumbnailUrl - URL of media item thumbnail to set

setType

public void setType(String type)

Sets the media item's type.

Parameters:

type - type to set; must be 'audio', 'image', or 'video'

setMimeType

public void setMimeType(String mimeType)

Sets the MIME type of the media item's content.

Parameters:

mimeType - MIME type to set

setCaption

public void setCaption(String caption)

Sets the media item's caption/title.

Parameters:

caption - caption/title to set

setDescription

public void setDescription(String description)

Sets the media item's description.

Parameters:

description - description to set