com.omertron.themoviedbapi.methods

Class TmdbLists

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbLists

public class TmdbLists
extends AbstractMethod

Class to hold the List Methods

Author:

stuart.boston

Field Summary

Fields inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

apiKey, httpTools, MAPPER

Constructor Summary

Constructors

Constructor and Description
TmdbLists(String apiKey, HttpTools httpTools) Constructor

Method Summary

Modifier and Type	Method and Description
StatusCode	addItem(String sessionId, String listId, int mediaId) This method lets users add new items to a list that they created.
boolean	checkItemStatus(String listId, int mediaId) Check to see if an ID is already on a list.
StatusCode	clear(String sessionId, String listId, boolean confirm) Clear all of the items within a list.
String	createList(String sessionId, String name, String description) This method lets users create a new list.
StatusCode	deleteList(String sessionId, String listId) This method lets users delete a list that they created.
ListItem<MovieInfo>	getList(String listId) Get a list by its ID
StatusCode	removeItem(String sessionId, String listId, int mediaId) This method lets users delete items from a list that they created.

Methods inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

getMediaChanges, getTypeReference, processWrapper, processWrapperList

Methods inherited from class java.lang.Object

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

Constructor Detail

TmdbLists

public TmdbLists(String apiKey,
                 HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

getList

public ListItem<MovieInfo> getList(String listId)
                            throws MovieDbException

Get a list by its ID

Parameters:

listId -

Returns:

The list and its items

Throws:

MovieDbException

checkItemStatus

public boolean checkItemStatus(String listId,
                               int mediaId)
                        throws MovieDbException

Check to see if an ID is already on a list.

Parameters:

listId -

mediaId -

Returns:

true if the movie is on the list

Throws:

MovieDbException

createList

public String createList(String sessionId,
                         String name,
                         String description)
                  throws MovieDbException

This method lets users create a new list. A valid session id is required.

Parameters:

sessionId -

name -

description -

Returns:

The list id

Throws:

MovieDbException

deleteList

public StatusCode deleteList(String sessionId,
                             String listId)
                      throws MovieDbException

This method lets users delete a list that they created. A valid session id is required.

Parameters:

sessionId -

listId -

Returns:

Throws:

MovieDbException

addItem

public StatusCode addItem(String sessionId,
                          String listId,
                          int mediaId)
                   throws MovieDbException

This method lets users add new items to a list that they created. A valid session id is required.

Parameters:

sessionId -

listId -

mediaId -

Returns:

Throws:

MovieDbException

removeItem

public StatusCode removeItem(String sessionId,
                             String listId,
                             int mediaId)
                      throws MovieDbException

This method lets users delete items from a list that they created. A valid session id is required.

Parameters:

sessionId -

listId -

mediaId -

Returns:

Throws:

MovieDbException

clear

public StatusCode clear(String sessionId,
                        String listId,
                        boolean confirm)
                 throws MovieDbException

Clear all of the items within a list. This is a irreversible action and should be treated with caution. A valid session id is required. A call without confirm=true will return status code 29.

Parameters:

sessionId -

listId -

confirm -

Returns:

Throws:

MovieDbException