com.flickr4java.flickr.collections

Class CollectionsInterface

java.lang.Object

com.flickr4java.flickr.collections.CollectionsInterface

public class CollectionsInterface
extends java.lang.Object

Interface for flickr.collections.* methods.

Constructor Summary

Constructors

Constructor and Description
CollectionsInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI)

Method Summary

Methods

Modifier and Type	Method and Description
Collection	getInfo(java.lang.String collectionId) Retrieves info on the given Flickr Collection (of Photosets).
java.util.List<Collection>	getTree(java.lang.String collectionId, java.lang.String userId) Retrieves a list of the current Commons institutions.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionsInterface

public CollectionsInterface(java.lang.String apiKey,
                    java.lang.String sharedSecret,
                    Transport transportAPI)

Method Detail

getInfo

public Collection getInfo(java.lang.String collectionId)
                   throws FlickrException

Retrieves info on the given Flickr Collection (of Photosets). This method requires authentication.

Parameters:

collectionId - the id of the collection (from the getTree call, not from the collection URL).

Returns:

the given Collection

Throws:

FlickrException

getTree

public java.util.List<Collection> getTree(java.lang.String collectionId,
                                 java.lang.String userId)
                                   throws FlickrException

Retrieves a list of the current Commons institutions. This method does not require authentication.

Parameters:

collectionId - the id of the collection (optional - returns all if not specified).

userId - the user id of the collection owner (optional - defaults to calling user).

Returns:

List of Institution

Throws:

FlickrException