com.omertron.themoviedbapi.methods

Class TmdbMovies

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbMovies

public class TmdbMovies
extends AbstractMethod

Class to hold the Movie Methods

Author:

stuart.boston

Field Summary

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

apiKey, httpTools, MAPPER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MovieInfo	getLatestMovie() This method is used to retrieve the newest movie that was added to TMDb.
MediaState	getMovieAccountState(int movieId, String sessionId) This method lets a user get the status of whether or not the movie has been rated or added to their favourite or movie watch list.
ResultList<AlternativeTitle>	getMovieAlternativeTitles(int movieId, String country) This method is used to retrieve all of the alternative titles we have for a particular movie.
ResultList<ChangeKeyItem>	getMovieChanges(int movieId, String startDate, String endDate) Get the changes for a specific movie ID.
MediaCreditList	getMovieCredits(int movieId) Get the cast and crew information for a specific movie id.
ResultList<Artwork>	getMovieImages(int movieId, String language) This method should be used when you’re wanting to retrieve all of the images for a particular movie.
MovieInfo	getMovieInfo(int movieId, String language, String... appendToResponse) This method is used to retrieve all of the basic movie information.
MovieInfo	getMovieInfoImdb(String imdbId, String language, String... appendToResponse) This method is used to retrieve all of the basic movie information.
ResultList<Keyword>	getMovieKeywords(int movieId) This method is used to retrieve all of the keywords that have been added to a particular movie.
ResultList<UserList>	getMovieLists(int movieId, Integer page, String language) Get the lists that the movie belongs to
ResultList<ReleaseInfo>	getMovieReleaseInfo(int movieId, String language) This method is used to retrieve all of the release and certification data we have for a specific movie.
ResultList<Review>	getMovieReviews(int movieId, Integer page, String language) Get the reviews for a particular movie id.
ResultList<Translation>	getMovieTranslations(int movieId) This method is used to retrieve a list of the available translations for a specific movie.
ResultList<Video>	getMovieVideos(int movieId, String language) This method is used to retrieve all of the trailers for a particular movie.
ResultList<MovieInfo>	getNowPlayingMovies(Integer page, String language) This method is used to retrieve the movies currently in theatres.
ResultList<MovieInfo>	getPopularMovieList(Integer page, String language) This method is used to retrieve the daily movie popularity list.
ResultList<ReleaseDates>	getReleaseDates(int movieId) Get the release dates, certifications and related information by country for a specific movie id.
ResultList<MovieInfo>	getSimilarMovies(int movieId, Integer page, String language) The similar movies method will let you retrieve the similar movies for a particular movie.
ResultList<MovieInfo>	getTopRatedMovies(Integer page, String language) This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
ResultList<MovieInfo>	getUpcoming(Integer page, String language) Get the list of upcoming movies.
StatusCode	postMovieRating(int movieId, int rating, String sessionId, String guestSessionId) This method lets users rate a movie.

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

TmdbMovies

public TmdbMovies(String apiKey,
                  HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

getMovieInfo

public MovieInfo getMovieInfo(int movieId,
                              String language,
                              String... appendToResponse)
                       throws MovieDbException

This method is used to retrieve all of the basic movie information. It will return the single highest rated poster and backdrop. ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.

Parameters:

movieId -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getMovieInfoImdb

public MovieInfo getMovieInfoImdb(String imdbId,
                                  String language,
                                  String... appendToResponse)
                           throws MovieDbException

This method is used to retrieve all of the basic movie information. It will return the single highest rated poster and backdrop. ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.

Parameters:

imdbId -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getMovieAccountState

public MediaState getMovieAccountState(int movieId,
                                       String sessionId)
                                throws MovieDbException

This method lets a user get the status of whether or not the movie has been rated or added to their favourite or movie watch list. A valid session id is required.

Parameters:

movieId -

sessionId -

Returns:

Throws:

MovieDbException

getMovieAlternativeTitles

public ResultList<AlternativeTitle> getMovieAlternativeTitles(int movieId,
                                                              String country)
                                                       throws MovieDbException

This method is used to retrieve all of the alternative titles we have for a particular movie.

Parameters:

movieId -

country -

Returns:

Throws:

MovieDbException

getMovieCredits

public MediaCreditList getMovieCredits(int movieId)
                                throws MovieDbException

Get the cast and crew information for a specific movie id.

Parameters:

movieId -

Returns:

Throws:

MovieDbException

getMovieImages

public ResultList<Artwork> getMovieImages(int movieId,
                                          String language)
                                   throws MovieDbException

This method should be used when you’re wanting to retrieve all of the images for a particular movie.

Parameters:

movieId -

language -

Returns:

Throws:

MovieDbException

getMovieKeywords

public ResultList<Keyword> getMovieKeywords(int movieId)
                                     throws MovieDbException

This method is used to retrieve all of the keywords that have been added to a particular movie. Currently, only English keywords exist.

Parameters:

movieId -

Returns:

Throws:

MovieDbException

getMovieReleaseInfo

public ResultList<ReleaseInfo> getMovieReleaseInfo(int movieId,
                                                   String language)
                                            throws MovieDbException

This method is used to retrieve all of the release and certification data we have for a specific movie.

Parameters:

movieId -

language -

Returns:

Throws:

MovieDbException

getMovieVideos

public ResultList<Video> getMovieVideos(int movieId,
                                        String language)
                                 throws MovieDbException

This method is used to retrieve all of the trailers for a particular movie. Supported sites are YouTube and QuickTime.

Parameters:

movieId -

language -

Returns:

Throws:

MovieDbException

getReleaseDates

public ResultList<ReleaseDates> getReleaseDates(int movieId)
                                         throws MovieDbException

Get the release dates, certifications and related information by country for a specific movie id. The results are keyed by country code and contain a type value.

Parameters:

movieId -

Returns:

Throws:

MovieDbException

getMovieTranslations

public ResultList<Translation> getMovieTranslations(int movieId)
                                             throws MovieDbException

This method is used to retrieve a list of the available translations for a specific movie.

Parameters:

movieId -

Returns:

Throws:

MovieDbException

getSimilarMovies

public ResultList<MovieInfo> getSimilarMovies(int movieId,
                                              Integer page,
                                              String language)
                                       throws MovieDbException

The similar movies method will let you retrieve the similar movies for a particular movie. This data is created dynamically but with the help of users votes on TMDb. The data is much better with movies that have more keywords

Parameters:

movieId -

language -

page -

Returns:

Throws:

MovieDbException

getMovieReviews

public ResultList<Review> getMovieReviews(int movieId,
                                          Integer page,
                                          String language)
                                   throws MovieDbException

Get the reviews for a particular movie id.

Parameters:

movieId -

page -

language -

Returns:

Throws:

MovieDbException

getMovieLists

public ResultList<UserList> getMovieLists(int movieId,
                                          Integer page,
                                          String language)
                                   throws MovieDbException

Get the lists that the movie belongs to

Parameters:

movieId -

language -

page -

Returns:

Throws:

MovieDbException

getMovieChanges

public ResultList<ChangeKeyItem> getMovieChanges(int movieId,
                                                 String startDate,
                                                 String endDate)
                                          throws MovieDbException

Get the changes for a specific movie ID. Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.

Parameters:

movieId -

startDate -

endDate -

Returns:

Throws:

MovieDbException

postMovieRating

public StatusCode postMovieRating(int movieId,
                                  int rating,
                                  String sessionId,
                                  String guestSessionId)
                           throws MovieDbException

This method lets users rate a movie. A valid session id or guest session id is required.

Parameters:

sessionId -

movieId -

rating -

guestSessionId -

Returns:

Throws:

MovieDbException

getLatestMovie

public MovieInfo getLatestMovie()
                         throws MovieDbException

This method is used to retrieve the newest movie that was added to TMDb.

Returns:

Throws:

MovieDbException

getUpcoming

public ResultList<MovieInfo> getUpcoming(Integer page,
                                         String language)
                                  throws MovieDbException

Get the list of upcoming movies. This list refreshes every day. The maximum number of items this list will include is 100.

Parameters:

language -

page -

Returns:

Throws:

MovieDbException

getNowPlayingMovies

public ResultList<MovieInfo> getNowPlayingMovies(Integer page,
                                                 String language)
                                          throws MovieDbException

This method is used to retrieve the movies currently in theatres. This is a curated list that will normally contain 100 movies. The default response will return 20 movies.

Parameters:

language -

page -

Returns:

Throws:

MovieDbException

getPopularMovieList

public ResultList<MovieInfo> getPopularMovieList(Integer page,
                                                 String language)
                                          throws MovieDbException

This method is used to retrieve the daily movie popularity list. This list is updated daily. The default response will return 20 movies.

Parameters:

language -

page -

Returns:

Throws:

MovieDbException

getTopRatedMovies

public ResultList<MovieInfo> getTopRatedMovies(Integer page,
                                               String language)
                                        throws MovieDbException

This method is used to retrieve the top rated movies that have over 10 votes on TMDb. The default response will return 20 movies.

Parameters:

language -

page -

Returns:

Throws:

MovieDbException