• Home
• com.github.fabienbarbero
• flickr-api
• 1.1
• source code
• PhotosetsService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.fabienbarbero.flickr.api.PhotosetsService Maven / Gradle / Ivy

/*
 * (C) Copyright 2014 Fabien Barbero.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl-2.1.html
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 */
package com.github.fabienbarbero.flickr.api;

import com.github.fabienbarbero.flickr.api.entities.BaseUser;
import com.github.fabienbarbero.flickr.api.entities.Comment;
import com.github.fabienbarbero.flickr.api.entities.CommentResponse;
import com.github.fabienbarbero.flickr.api.entities.CommentsResponse;
import com.github.fabienbarbero.flickr.api.entities.Paginated;
import com.github.fabienbarbero.flickr.api.entities.PhotosResponse;
import com.github.fabienbarbero.flickr.api.entities.Photo;
import com.github.fabienbarbero.flickr.api.entities.Photoset;
import com.github.fabienbarbero.flickr.api.entities.PhotosetInfos;
import com.github.fabienbarbero.flickr.api.entities.PhotosetInfosResponse;
import com.github.fabienbarbero.flickr.api.entities.PhotosetResponse;
import com.github.fabienbarbero.flickr.api.entities.PhotosetsResponse;
import com.github.fabienbarbero.flickr.api.entities.VoidResponse;
import java.util.List;

/**
 *
 * @author Fabien Barbero
 */
public class PhotosetsService
        extends FlickrService
{

    PhotosetsService( OAuthHandler oauthHandler )
    {
        super( oauthHandler );
    }

    /**
     * Returns the photosets belonging to the specified user.
     *
     * @param user The user to get a photoset list for
     * @param perPage The number of sets to get per page. The maximum number of sets per page is 500.
     * @param page The page of results to get
     * @return The sets
     * @throws FlickrException Error getting the sets
     */
    public Paginated getPhotosets( BaseUser user, int perPage, int page )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.getList" );
        args.addParam( "user_id", user.getId() );
        args.addParam( "per_page", perPage );
        args.addParam( "page", page );
        return doGet( args, PhotosetsResponse.class ).getPaginated();
    }

    /**
     * Get the list of photos in a set.
     *
     * @param photoset The photoset
     * @param perPage Number of photos to return per page. The maximum allowed value is 500.
     * @param page The page of results to return
     * @return The photos
     * @throws FlickrException Error getting the photos
     */
    public Paginated getPhotos( Photoset photoset, int perPage, int page )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.getPhotos" );
        args.addParam( "photoset_id", photoset.getId() );
        args.addParam( "per_page", perPage );
        args.addParam( "page", page );
        return doGet( args, PhotosResponse.class ).getPaginated();
    }

    /**
     * Gets information about a photoset.
     *
     * @param photoset The photoset
     * @return The photoset
     * @throws FlickrException Error getting the set
     */
    public PhotosetInfos getInfos( Photoset photoset )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.getInfo" );
        args.addParam( "photoset_id", photoset.getId() );
        return doGet( args, PhotosetInfosResponse.class ).getInfos();
    }

    /**
     * Returns the comments for a photoset.
     *
     * @param photoset The photoset
     * @return The comments
     * @throws FlickrException Error getting the comments
     */
    public List getComments( Photoset photoset )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.comments.getList" );
        args.addParam( "photoset_id", photoset.getId() );
        return doGet( args, CommentsResponse.class ).getList();
    }

    /**
     * Create a new photoset
     *
     * @param title The photoset title
     * @param description The photoset description
     * @param primaryPhoto The photoset priùary photo
     * @return The new photoset
     * @throws FlickrException Error creating the photoset
     */
    public Photoset createPhotoset( String title, String description, Photo primaryPhoto )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.create" );
        args.addParam( "title", title );
        args.addParam( "description", description );
        args.addParam( "primary_photo_id", primaryPhoto.getId() );
        return doPost( args, PhotosetResponse.class ).getPhotoset();
    }

    /**
     * Delete a photoset
     *
     * @param photoset The photoset to delete
     * @throws FlickrException Error deleting the photoset
     */
    public void deletePhotoset( Photoset photoset )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.delete" );
        args.addParam( "photoset_id", photoset.getId() );
        doPost( args, VoidResponse.class );
    }

    /**
     * Modify the meta-data for a photoset.
     *
     * @param photoset The photoset to modify
     * @param title The new title
     * @param description The new description
     * @throws FlickrException Error editing the meta
     */
    public void editPhotosetMeta( Photoset photoset, String title, String description )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.editMeta" );
        args.addParam( "photoset_id", photoset.getId() );
        args.addParam( "title", title );
        args.addParam( "description", description );
        doPost( args, VoidResponse.class );
    }

    /**
     * Set photoset primary photo
     *
     * @param photoset The photoset
     * @param primaryPhoto The new primary photo
     * @throws FlickrException Error setting the primary photo
     */
    public void setPrimaryPhoto( Photoset photoset, Photo primaryPhoto )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.setPrimaryPhoto" );
        args.addParam( "photoset_id", photoset.getId() );
        args.addParam( "photo_id", primaryPhoto.getId() );
        doPost( args, VoidResponse.class );
    }

    /**
     * Add a photo to a set
     *
     * @param photoset The set
     * @param photo The photo to add
     * @throws FlickrException Error adding the photo
     */
    public void addPhotoToSet( Photoset photoset, Photo photo )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.addPhoto" );
        args.addParam( "photoset_id", photoset.getId() );
        args.addParam( "photo_id", photo.getId() );
        doPost( args, VoidResponse.class );
    }

    /**
     * Remove multiple photos from a photoset.
     *
     * @param photoset The photoset
     * @param photos The photos to remove
     * @throws FlickrException Error removing the photos
     */
    public void removePhotosFromSet( Photoset photoset, Photo... photos )
            throws FlickrException
    {
        StringBuilder builder = new StringBuilder();
        for ( Photo photo : photos ) {
            builder.append( photo.getId() ).append( "," );
        }

        CommandArguments args = new CommandArguments( "flickr.photosets.removePhotos" );
        args.addParam( "photoset_id", photoset.getId() );
        args.addParam( "photo_ids", builder );
        doPost( args, VoidResponse.class );
    }

    /**
     * Add a comment to the photoset
     *
     * @param photoset The photoset
     * @param text The comment text
     * @return The created comment
     * @throws FlickrException Error adding the comment
     */
    public Comment addComment( Photoset photoset, String text )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.comments.addComment" );
        args.addParam( "photoset_id", photoset.getId() );
        args.addParam( "comment_text", text );
        return doPost( args, CommentResponse.class ).getComment();
    }

    /**
     * Delete a comment on a photoset
     *
     * @param comment The comment to delete
     * @throws FlickrException Error deleting the comment
     */
    public void deleteComment( Comment comment )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.comments.deleteComment" );
        args.addParam( "comment_id", comment.getId() );
        doPost( args, VoidResponse.class );
    }

    /**
     * Edit the text of a comment as the currently authenticated user.
     *
     * @param comment The comment to edit
     * @param text The new comment text
     * @throws FlickrException Error editing the comment
     */
    public void editComment( Comment comment, String text )
            throws FlickrException
    {
        CommandArguments args = new CommandArguments( "flickr.photosets.comments.editComment" );
        args.addParam( "comment_id", comment.getId() );
        args.addParam( "comment_text", text );
        doPost( args, VoidResponse.class );
    }

}