public interface

AlbumData

implements BoxData PointData GphotoData MediaData
com.google.gdata.data.photos.AlbumData
Known Indirect Subclasses

Class Overview

Data interface for album feeds and entries. This allows a common interface between entries and feed that are about album kinds, making working with these data objects easier. An album may contain media in the form of the cover image for the album, as well as containing geographic information in the form of coordinates.

Summary

Constants
String ALBUM_KIND The fully qualified king term for albums.
String KIND The unqualified kind for an album.
Fields
public static final Category ALBUM_CATEGORY A category object for albums.
Public Methods
abstract String getAccess()
The access level of the album, either private, protected, or public.
abstract Long getBytesUsed()
The number of bytes that are used by photos in this album.
abstract Integer getCommentCount()
The number of comments on the album.
abstract Boolean getCommentsEnabled()
Whether or not commenting is allowed on this album.
abstract Date getDate()
The date the album was taken.
abstract String getLocation()
The location of the album is a string representing where the photos in the album where taken.
abstract String getName()
The name of the album is its canonicalized title.
abstract String getNickname()
The nickname of the user who owns the album.
abstract Integer getPhotosLeft()
The number of spaces for photos that are available in the album.
abstract Integer getPhotosUsed()
The number of photos that are contained in this album.
abstract String getUsername()
The username of the owner of the album.
abstract void setAccess(String access)
Set the access for the album this data object represents.
abstract void setBytesUsed(Long bytesUsed)
Set the number of bytes used in the album this data object represents.
abstract void setCommentCount(Integer commentCount)
Set the number of comments on the album.
abstract void setCommentsEnabled(Boolean commentsEnabled)
Set the whether comments are enabled in the album.
abstract void setDate(Date date)
Set the date of the album.
abstract void setLocation(String location)
Set the location string for where the photos in the album were taken.
abstract void setName(String name)
Set the canonical name of the album.
abstract void setNickname(String nickname)
Set the nickname for the owner of the album this data object represents.
abstract void setPhotosLeft(Integer photosLeft)
Set the number of photos remaining that can be uploaded to this album.
abstract void setPhotosUsed(Integer photosUsed)
Set the number of photos used on the album this data object represents.
abstract void setUsername(String username)
Set the username for the owner of the album this data object represents.
[Expand]
Inherited Methods
From interface com.google.gdata.data.geo.BoxData
From interface com.google.gdata.data.geo.PointData
From interface com.google.gdata.data.photos.Extensible
From interface com.google.gdata.data.photos.GphotoData
From interface com.google.gdata.data.photos.MediaData

Constants

public static final String ALBUM_KIND

The fully qualified king term for albums.

Constant Value: "http://schemas.google.com/photos/2007#album"

public static final String KIND

The unqualified kind for an album.

Constant Value: "album"

Fields

public static final Category ALBUM_CATEGORY

A category object for albums. All album objects will have this set.

Public Methods

public abstract String getAccess ()

The access level of the album, either private, protected, or public. This may be null when the access level of the album is not known.

Returns
  • the access of the album.

public abstract Long getBytesUsed ()

The number of bytes that are used by photos in this album. Useful to see how much space each album is taking up of the user's quota. This method is calculated by the server so it should be considered read-only by the client.

Returns
  • the number of bytes used in the album.
Throws
ServiceException

public abstract Integer getCommentCount ()

The number of comments on the album. This is calculated based on the comments stored on the server.

Returns
  • the comment count on the album.
Throws
ServiceException

public abstract Boolean getCommentsEnabled ()

Whether or not commenting is allowed on this album. If set to true then comments may be added to the album, if set to false then no comments can be made on photos in this album.

Returns
  • true if comments are enabled in this album the feed represents.
Throws
ServiceException

public abstract Date getDate ()

The date the album was taken. Date ranges are not currently allowed. This is typically set to the date the earliest photo in the album was taken.

Returns
  • the date on the album, set by the user.
Throws
ServiceException

public abstract String getLocation ()

The location of the album is a string representing where the photos in the album where taken.

Returns
  • the location of the album.

public abstract String getName ()

The name of the album is its canonicalized title. This is the name that can be used in urls to access the album by name rather than by id.

Returns
  • the (canonical) name of the album.

public abstract String getNickname ()

The nickname of the user who owns the album. This is provided to make it easier to display ownership information about albums. This is a read only field calculated by the server based on the owner of the album.

Returns
  • the nickname of the owner of the album.

public abstract Integer getPhotosLeft ()

The number of spaces for photos that are available in the album. This should be treated as a read only field as it is calculated on the server. Once 0 photos are left no more photos can be uploaded to this album until photos have been deleted.

Returns
  • the number of photos remaining in the album.
Throws
ServiceException

public abstract Integer getPhotosUsed ()

The number of photos that are contained in this album. This should be treated as a read only field, it is calculated on the server.

Returns
  • the number of photos used in the album.
Throws
ServiceException

public abstract String getUsername ()

The username of the owner of the album. This username can be used to query for the gallery of the owner of the album, for example.

Returns
  • the username of the owner of the album.

public abstract void setAccess (String access)

Set the access for the album this data object represents. Valid values are "private" or "public". Anything other than "public" will be set as "private", which is the default.

Parameters
access The access level of the album.

public abstract void setBytesUsed (Long bytesUsed)

Set the number of bytes used in the album this data object represents. This method is used by the server, setting this on the client will have no effect.

Parameters
bytesUsed The number of bytes used.

public abstract void setCommentCount (Integer commentCount)

Set the number of comments on the album. Used by the server, this has no effect on the client.

Parameters
commentCount The number of comments on the album.

public abstract void setCommentsEnabled (Boolean commentsEnabled)

Set the whether comments are enabled in the album. This will change the setting on the server if set by the owner of the album and updated.

Parameters
commentsEnabled True if comments are enabled in the album.

public abstract void setDate (Date date)

Set the date of the album. Dates that are too early will be truncated by the server, where too early currently means anything before 1970.

Parameters
date The date the album represents.

public abstract void setLocation (String location)

Set the location string for where the photos in the album were taken. This string may be geocoded by the server to provide coordinates based on the location.

Parameters
location The location of the album.

public abstract void setName (String name)

Set the canonical name of the album. This is used on the server. If you wish to change the title of the album you should instead use setTitle(com.google.gdata.data.TextConstruct).

Parameters
name The canonical name of the album.

public abstract void setNickname (String nickname)

Set the nickname for the owner of the album this data object represents. This is used by the server and has no effect on the client.

Parameters
nickname The nickname of the owner.

public abstract void setPhotosLeft (Integer photosLeft)

Set the number of photos remaining that can be uploaded to this album. This is used by the server, changing this value on the client will have no effect.

Parameters
photosLeft The number of photos left.

public abstract void setPhotosUsed (Integer photosUsed)

Set the number of photos used on the album this data object represents. This is used by the server, changing this value on the client will have no effect.

Parameters
photosUsed The number of photos used.

public abstract void setUsername (String username)

Set the username for the owner of the album this data object represents. This is used by the server, setting it on the client will have no effect. We currently do not support moving albums between users.

Parameters
username The username of the owner.