com.omertron.themoviedbapi.methods

Class TmdbSearch

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbSearch

public class TmdbSearch
extends AbstractMethod

Class to hold the Search Methods

Author:

stuart.boston

Field Summary

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

apiKey, httpTools, MAPPER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResultList<Collection>	searchCollection(String query, Integer page, String language) Search for collections by name.
ResultList<Company>	searchCompanies(String query, Integer page) Search Companies.
ResultList<Keyword>	searchKeyword(String query, Integer page) Search for keywords by name
ResultList<MovieInfo>	searchMovie(String query, Integer page, String language, Boolean includeAdult, Integer searchYear, Integer primaryReleaseYear, SearchType searchType) Search Movies This is a good starting point to start finding movies on TMDb.
ResultList<MediaBasic>	searchMulti(String query, Integer page, String language, Boolean includeAdult) Search the movie, tv show and person collections with a single query.
ResultList<PersonFind>	searchPeople(String query, Integer page, Boolean includeAdult, SearchType searchType) This is a good starting point to start finding people on TMDb.
ResultList<TVBasic>	searchTV(String query, Integer page, String language, Integer firstAirDateYear, SearchType searchType) Search for TV shows by title.

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

TmdbSearch

public TmdbSearch(String apiKey,
                  HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

searchCompanies

public ResultList<Company> searchCompanies(String query,
                                           Integer page)
                                    throws MovieDbException

Search Companies. You can use this method to search for production companies that are part of TMDb. The company IDs will map to those returned on movie calls. http://help.themoviedb.org/kb/api/search-companies

Parameters:

query -

page -

Returns:

Throws:

MovieDbException

searchCollection

public ResultList<Collection> searchCollection(String query,
                                               Integer page,
                                               String language)
                                        throws MovieDbException

Search for collections by name.

Parameters:

query -

language -

page -

Returns:

Throws:

MovieDbException

searchKeyword

public ResultList<Keyword> searchKeyword(String query,
                                         Integer page)
                                  throws MovieDbException

Search for keywords by name

Parameters:

query -

page -

Returns:

Throws:

MovieDbException

searchMovie

public ResultList<MovieInfo> searchMovie(String query,
                                         Integer page,
                                         String language,
                                         Boolean includeAdult,
                                         Integer searchYear,
                                         Integer primaryReleaseYear,
                                         SearchType searchType)
                                  throws MovieDbException

Search Movies This is a good starting point to start finding movies on TMDb.

Parameters:

query -

searchYear - Limit the search to the provided year. Zero (0) will get all years

language - The language to include. Can be blank/null.

includeAdult - true or false to include adult titles in the search

page - The page of results to return. 0 to get the default (first page)

primaryReleaseYear -

searchType -

Returns:

Throws:

MovieDbException

searchMulti

public ResultList<MediaBasic> searchMulti(String query,
                                          Integer page,
                                          String language,
                                          Boolean includeAdult)
                                   throws MovieDbException

Search the movie, tv show and person collections with a single query. Each item returned in the result array has a media_type field that maps to either movie, tv or person. Each mapped result is the same response you would get from each independent search

Parameters:

query -

page -

language -

includeAdult -

Returns:

Throws:

MovieDbException

searchPeople

public ResultList<PersonFind> searchPeople(String query,
                                           Integer page,
                                           Boolean includeAdult,
                                           SearchType searchType)
                                    throws MovieDbException

This is a good starting point to start finding people on TMDb. The idea is to be a quick and light method so you can iterate through people quickly.

Parameters:

query -

includeAdult -

page -

searchType -

Returns:

Throws:

MovieDbException

searchTV

public ResultList<TVBasic> searchTV(String query,
                                    Integer page,
                                    String language,
                                    Integer firstAirDateYear,
                                    SearchType searchType)
                             throws MovieDbException

Search for TV shows by title.

Parameters:

query -

page -

language -

firstAirDateYear -

searchType -

Returns:

Throws:

MovieDbException