com.aetrion.flickr.groups.pools
Class PoolsInterface

java.lang.Object
  com.aetrion.flickr.groups.pools.PoolsInterface

public class PoolsInterface
extends java.lang.Object

Version:

$Id: PoolsInterface.java,v 1.12 2007/09/12 22:39:27 x-mago Exp $

Author:

Anthony Eden

Field Summary

static java.lang.String	METHOD_ADD
static java.lang.String	METHOD_GET_CONTEXT
static java.lang.String	METHOD_GET_GROUPS
static java.lang.String	METHOD_GET_PHOTOS
static java.lang.String	METHOD_REMOVE

Constructor Summary

PoolsInterface(java.lang.String apiKey, Transport transport)

Method Summary

void	add(java.lang.String photoId, java.lang.String groupId) Add a photo to a group's pool.
PhotoContext	getContext(java.lang.String photoId, java.lang.String groupId) Get the context for a photo in the group pool.
java.util.Collection	getGroups() Get a collection of all of the user's groups.
PhotoList	getPhotos(java.lang.String groupId, java.lang.String[] tags, int perPage, int page) Convenience/Compatibility method.
PhotoList	getPhotos(java.lang.String groupId, java.lang.String[] tags, java.util.Set extras, int perPage, int page) Get the photos for the specified group pool, optionally filtering by taf.
void	remove(java.lang.String photoId, java.lang.String groupId) Remove the specified photo from the group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METHOD_ADD

public static final java.lang.String METHOD_ADD

See Also:

Constant Field Values

METHOD_GET_CONTEXT

public static final java.lang.String METHOD_GET_CONTEXT

See Also:

Constant Field Values

METHOD_GET_GROUPS

public static final java.lang.String METHOD_GET_GROUPS

See Also:

Constant Field Values

METHOD_GET_PHOTOS

public static final java.lang.String METHOD_GET_PHOTOS

See Also:

Constant Field Values

METHOD_REMOVE

public static final java.lang.String METHOD_REMOVE

See Also:

Constant Field Values

Constructor Detail

PoolsInterface

public PoolsInterface(java.lang.String apiKey,
                      Transport transport)

Method Detail

add

public void add(java.lang.String photoId,
                java.lang.String groupId)
         throws java.io.IOException,
                org.xml.sax.SAXException,
                FlickrException

Add a photo to a group's pool.

Parameters:

photoId - The photo ID

groupId - The group ID

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException

getContext

public PhotoContext getContext(java.lang.String photoId,
                               java.lang.String groupId)
                        throws java.io.IOException,
                               org.xml.sax.SAXException,
                               FlickrException

Get the context for a photo in the group pool.

Parameters:

photoId - The photo ID

groupId - The group ID

Returns:

The PhotoContext

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException

getGroups

public java.util.Collection getGroups()
                               throws java.io.IOException,
                                      org.xml.sax.SAXException,
                                      FlickrException

Get a collection of all of the user's groups.

Returns:

A Collection of Group objects

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException

getPhotos

public PhotoList getPhotos(java.lang.String groupId,
                           java.lang.String[] tags,
                           java.util.Set extras,
                           int perPage,
                           int page)
                    throws java.io.IOException,
                           org.xml.sax.SAXException,
                           FlickrException

Get the photos for the specified group pool, optionally filtering by taf.

Parameters:

groupId - The group ID

tags - The optional tags (may be null)

extras - Set of extra-attributes to include (may be null)

perPage - The number of photos per page (0 to ignore)

page - The page offset (0 to ignore)

Returns:

A Collection of Photo objects

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException

See Also:

Extras

getPhotos

public PhotoList getPhotos(java.lang.String groupId,
                           java.lang.String[] tags,
                           int perPage,
                           int page)
                    throws java.io.IOException,
                           org.xml.sax.SAXException,
                           FlickrException

Convenience/Compatibility method.

Parameters:

groupId - The group ID

tags - The optional tags (may be null)

perPage - The number of photos per page (0 to ignore)

page - The page offset (0 to ignore)

Returns:

A Collection of Photo objects

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException

See Also:

Extras

remove

public void remove(java.lang.String photoId,
                   java.lang.String groupId)
            throws java.io.IOException,
                   org.xml.sax.SAXException,
                   FlickrException

Remove the specified photo from the group.

Parameters:

photoId - The photo ID

groupId - The group ID

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException