com.omertron.themoviedbapi.methods
Class TV

java.lang.Object
  com.omertron.themoviedbapi.methods.AbstractMethod
      com.omertron.themoviedbapi.methods.TV

public class TV
extends AbstractMethod

Class to hold the TV methods

Author:

stuart.boston

Field Summary

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

apiKey, httpClient, mapper

Constructor Summary

TV(String apiKey, org.yamj.api.common.http.CommonHttpClient httpClient)

Method Summary

TVSeries	getTv(int id, String language, String[] appendToResponse) Get the primary information about a TV series by id.
TmdbResultsList<Person>	getTvCredits(int id, String language, String[] appendToResponse) Get the cast & crew information about a TV series.
TVEpisode	getTvEpisode(int id, int seasonNumber, int episodeNumber, String language, String[] appendToResponse) Get the primary information about a TV episode by combination of a season and episode number.
TmdbResultsList<Person>	getTvEpisodeCredits(int id, int seasonNumber, int episodeNumber, String language) Get the TV episode credits by combination of season and episode number.
ExternalIds	getTvEpisodeExternalIds(int id, int seasonNumber, int episodeNumber, String language) Get the external ids for a TV episode by combination of a season and episode number.
String	getTvEpisodeImages(int id, int seasonNumber, int episodeNumber, String language) Get the images (episode stills) for a TV episode by combination of a season and episode number.
ExternalIds	getTvExternalIds(int id, String language) Get the external ids that we have stored for a TV series.
TmdbResultsList<Artwork>	getTvImages(int id, String language) Get the images (posters and backdrops) for a TV series.
TVSeason	getTvSeason(int id, int seasonNumber, String language, String[] appendToResponse) Get the primary information about a TV season by its season number.
ExternalIds	getTvSeasonExternalIds(int id, int seasonNumber, String language) Get the external ids that we have stored for a TV season by season number.
TmdbResultsList<Artwork>	getTvSeasonImages(int id, int seasonNumber, String language) Get the images (posters) that we have stored for a TV season by season number.
TmdbResultsList<TVSeriesBasic>	searchTv(String name, int searchYear, String language, SearchType searchType, int page) Search for TV shows by title.

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

requestWebPage, requestWebPage, requestWebPage

Methods inherited from class java.lang.Object

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

Constructor Detail

TV

public TV(String apiKey,
          org.yamj.api.common.http.CommonHttpClient httpClient)

Method Detail

searchTv

public TmdbResultsList<TVSeriesBasic> searchTv(String name,
                                               int searchYear,
                                               String language,
                                               SearchType searchType,
                                               int page)
                                        throws MovieDbException

Search for TV shows by title.

Parameters:

name -

searchYear -

language -

searchType -

page -

Returns:

Throws:

MovieDbException

getTv

public TVSeries getTv(int id,
                      String language,
                      String[] appendToResponse)
               throws MovieDbException

Get the primary information about a TV series by id.

Parameters:

id -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getTvCredits

public TmdbResultsList<Person> getTvCredits(int id,
                                            String language,
                                            String[] appendToResponse)
                                     throws MovieDbException

Get the cast & crew information about a TV series.
Just like the website, this information is pulled from the LAST season of the series.

Parameters:

id -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getTvExternalIds

public ExternalIds getTvExternalIds(int id,
                                    String language)
                             throws MovieDbException

Get the external ids that we have stored for a TV series.

Parameters:

id -

language -

Returns:

Throws:

MovieDbException

getTvImages

public TmdbResultsList<Artwork> getTvImages(int id,
                                            String language)
                                     throws MovieDbException

Get the images (posters and backdrops) for a TV series.

Parameters:

id -

language -

Returns:

Throws:

MovieDbException

getTvSeason

public TVSeason getTvSeason(int id,
                            int seasonNumber,
                            String language,
                            String[] appendToResponse)
                     throws MovieDbException

Get the primary information about a TV season by its season number.

Parameters:

id -

seasonNumber -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getTvSeasonExternalIds

public ExternalIds getTvSeasonExternalIds(int id,
                                          int seasonNumber,
                                          String language)
                                   throws MovieDbException

Get the external ids that we have stored for a TV season by season number.

Parameters:

id -

seasonNumber -

language -

Returns:

Throws:

MovieDbException

getTvSeasonImages

public TmdbResultsList<Artwork> getTvSeasonImages(int id,
                                                  int seasonNumber,
                                                  String language)
                                           throws MovieDbException

Get the images (posters) that we have stored for a TV season by season number.

Parameters:

id -

seasonNumber -

language -

Returns:

Throws:

MovieDbException

getTvEpisode

public TVEpisode getTvEpisode(int id,
                              int seasonNumber,
                              int episodeNumber,
                              String language,
                              String[] appendToResponse)
                       throws MovieDbException

Get the primary information about a TV episode by combination of a season and episode number.

Parameters:

id -

seasonNumber -

episodeNumber -

language -

appendToResponse -

Returns:

Throws:

MovieDbException

getTvEpisodeCredits

public TmdbResultsList<Person> getTvEpisodeCredits(int id,
                                                   int seasonNumber,
                                                   int episodeNumber,
                                                   String language)
                                            throws MovieDbException

Get the TV episode credits by combination of season and episode number.

Parameters:

id -

seasonNumber -

episodeNumber -

language -

Returns:

Throws:

MovieDbException

getTvEpisodeExternalIds

public ExternalIds getTvEpisodeExternalIds(int id,
                                           int seasonNumber,
                                           int episodeNumber,
                                           String language)
                                    throws MovieDbException

Get the external ids for a TV episode by combination of a season and episode number.

Parameters:

id -

seasonNumber -

episodeNumber -

language -

Returns:

Throws:

MovieDbException

getTvEpisodeImages

public String getTvEpisodeImages(int id,
                                 int seasonNumber,
                                 int episodeNumber,
                                 String language)
                          throws MovieDbException

Get the images (episode stills) for a TV episode by combination of a season and episode number.

Parameters:

id -

seasonNumber -

episodeNumber -

language -

Returns:

Throws:

MovieDbException