com.omertron.themoviedbapi.model.discover

Class Discover

java.lang.Object

com.omertron.themoviedbapi.model.discover.Discover

public class Discover
extends Object

Generate a discover object for use in the MovieDbApi

This allows you to just add the search components you are concerned with

Author:

stuart.boston

Constructor Summary

Constructors

Constructor and Description
Discover()

Method Summary

Methods

Modifier and Type	Method and Description
Discover	certification(String certification) Only include movies with this certification.
Discover	certificationCountry(String certificationCountry) Only include movies with certifications for a specific country.
Discover	certificationLte(String certificationLte) Only include movies with this certification and lower.
Discover	firstAirDateYear(int year) Filter the air dates that match this year Expected value is a year.
Discover	firstAirDateYearGte(int year) Filter the air dates to years that are greater than or equal to this year
Discover	firstAirDateYearLte(int year) Filter the air dates to years that are less than or equal to this year
TmdbParameters	getParams() Get the parameters
Discover	includeAdult(boolean includeAdult) Toggle the inclusion of adult titles
Discover	includeVideo(boolean includeVideo) Toggle the inclusion of items marked as a video.
Discover	language(String language) ISO 639-1 code
Discover	page(int page) Minimum value is 1 if included.
Discover	primaryReleaseYear(int primaryReleaseYear) Filter the results so that only the primary release date year has this value
Discover	releaseDateGte(String releaseDateGte) The minimum release to include.
Discover	releaseDateLte(String releaseDateLte) The maximum release to include.
Discover	sortBy(SortBy sortBy) Available options are vote_average.desc vote_average.asc release_date.desc release_date.asc popularity.desc popularity.asc
Discover	voteAverageGte(float voteAverageGte) Only include movies that are equal to, or have a higher average rating than this value
Discover	voteAverageLte(float voteAverageLte) Only include movies that are less than or equal to this value
Discover	voteCountGte(int voteCountGte) Only include movies that are equal to, or have a vote count higher than this value
Discover	voteCountLte(int voteCountLte) Only include movies that are equal to, or have a vote count higher than this value
Discover	withCast(String withCast) Only include movies that have this person id added as a cast member.
Discover	withCast(WithBuilder withCast) Only include media that have these person IDs added as cast members.
Discover	withCompanies(String withCompanies) Filter movies to include a specific company.
Discover	withCompanies(WithBuilder withCompanies) Filter movies to include a specific company.
Discover	withCrew(String withCrew) Only include movies that have this person id added as a crew member.
Discover	withCrew(WithBuilder withCrew) Only include media that have these person IDs added as crew members.
Discover	withGenres(String withGenres) Only include movies with the specified genres.
Discover	withGenres(WithBuilder withGenres) Only include movies with the specified genres.
Discover	withKeywords(String withKeywords) Only include movies with the specified genres.
Discover	withKeywords(WithBuilder withKeywords) Only include movies with the specified genres.
Discover	withNetworks(String withNetworks) Filter TV shows to include a specific network.
Discover	withNetworks(WithBuilder withNetworks) Filter TV shows to include a specific network.
Discover	withPeople(String withPeople) Only include movies that have these person id's added as a cast or crew member.
Discover	withPeople(WithBuilder withPeople) Only include movies that have these person id's added as a cast or crew member.
Discover	year(int year) Filter the results release dates to matches that include this value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Discover

public Discover()

Method Detail

getParams

public TmdbParameters getParams()

Get the parameters

This will be used to construct the URL in the API

Returns:

page

public Discover page(int page)

Minimum value is 1 if included.

Parameters:

page -

Returns:

language

public Discover language(String language)

ISO 639-1 code

Parameters:

language -

Returns:

sortBy

public Discover sortBy(SortBy sortBy)

Available options are
vote_average.desc
vote_average.asc
release_date.desc
release_date.asc
popularity.desc
popularity.asc

Parameters:

sortBy -

Returns:

includeAdult

public Discover includeAdult(boolean includeAdult)

Toggle the inclusion of adult titles

Parameters:

includeAdult -

Returns:

includeVideo

public Discover includeVideo(boolean includeVideo)

Toggle the inclusion of items marked as a video. Expected value is a boolean, true or false. Default is true.

Parameters:

includeVideo -

Returns:

year

public Discover year(int year)

Filter the results release dates to matches that include this value.

Parameters:

year -

Returns:

primaryReleaseYear

public Discover primaryReleaseYear(int primaryReleaseYear)

Filter the results so that only the primary release date year has this value

Parameters:

primaryReleaseYear -

Returns:

voteCountGte

public Discover voteCountGte(int voteCountGte)

Only include movies that are equal to, or have a vote count higher than this value

Parameters:

voteCountGte -

Returns:

voteCountLte

public Discover voteCountLte(int voteCountLte)

Only include movies that are equal to, or have a vote count higher than this value

Parameters:

voteCountLte -

Returns:

voteAverageGte

public Discover voteAverageGte(float voteAverageGte)

Only include movies that are equal to, or have a higher average rating than this value

Parameters:

voteAverageGte -

Returns:

voteAverageLte

public Discover voteAverageLte(float voteAverageLte)

Only include movies that are less than or equal to this value

Parameters:

voteAverageLte -

Returns:

releaseDateGte

public Discover releaseDateGte(String releaseDateGte)

The minimum release to include.

Expected format is YYYY-MM-DD.

Parameters:

releaseDateGte -

Returns:

releaseDateLte

public Discover releaseDateLte(String releaseDateLte)

The maximum release to include.

Expected format is YYYY-MM-DD.

Parameters:

releaseDateLte -

Returns:

certificationCountry

public Discover certificationCountry(String certificationCountry)

Only include movies with certifications for a specific country.

When this value is specified, 'certificationLte' is required.

A ISO 3166-1 is expected

Parameters:

certificationCountry -

Returns:

certificationLte

public Discover certificationLte(String certificationLte)

Only include movies with this certification and lower.

Expected value is a valid certification for the specified 'certificationCountry'.

Parameters:

certificationLte -

Returns:

certification

public Discover certification(String certification)

Only include movies with this certification. Expected value is a valid certification for the specified 'certificationCountry'.

Parameters:

certification -

Returns:

withCast

public Discover withCast(String withCast)

Only include movies that have this person id added as a cast member. Expected value is an integer (the id of a person). Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'

Parameters:

withCast -

Returns:

withCast

public Discover withCast(WithBuilder withCast)

Only include media that have these person IDs added as cast members. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withCast -

Returns:

withCrew

public Discover withCrew(String withCrew)

Only include movies that have this person id added as a crew member. Expected value is an integer (the id of a person). Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.

Parameters:

withCrew -

Returns:

withCrew

public Discover withCrew(WithBuilder withCrew)

Only include media that have these person IDs added as crew members. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withCrew -

Returns:

withCompanies

public Discover withCompanies(String withCompanies)

Filter movies to include a specific company. Expected value is an integer (the id of a company). Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'

Parameters:

withCompanies -

Returns:

withCompanies

public Discover withCompanies(WithBuilder withCompanies)

Filter movies to include a specific company. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withCompanies -

Returns:

withGenres

public Discover withGenres(String withGenres)

Only include movies with the specified genres.

Expected value is an integer (the id of a genre).

Multiple values can be specified.

Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'

Parameters:

withGenres -

Returns:

withGenres

public Discover withGenres(WithBuilder withGenres)

Only include movies with the specified genres. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withGenres -

Returns:

withKeywords

public Discover withKeywords(String withKeywords)

Only include movies with the specified genres. Expected value is an integer (the id of a genre). Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.

Parameters:

withKeywords -

Returns:

withKeywords

public Discover withKeywords(WithBuilder withKeywords)

Only include movies with the specified genres. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withKeywords -

Returns:

withPeople

public Discover withPeople(String withPeople)

Only include movies that have these person id's added as a cast or crew member. Expected value is an integer (the id or ids of a person). Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.

Parameters:

withPeople -

Returns:

withPeople

public Discover withPeople(WithBuilder withPeople)

Only include movies that have these person id's added as a cast or crew member. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withPeople -

Returns:

firstAirDateYear

public Discover firstAirDateYear(int year)

Filter the air dates that match this year Expected value is a year.

Parameters:

year -

Returns:

firstAirDateYearGte

public Discover firstAirDateYearGte(int year)

Filter the air dates to years that are greater than or equal to this year

Parameters:

year -

Returns:

firstAirDateYearLte

public Discover firstAirDateYearLte(int year)

Filter the air dates to years that are less than or equal to this year

Parameters:

year -

Returns:

withNetworks

public Discover withNetworks(String withNetworks)

Filter TV shows to include a specific network. Expected value is an integer (the id of a network). They can be comma separated to indicate an 'AND' query.

Parameters:

withNetworks -

Returns:

withNetworks

public Discover withNetworks(WithBuilder withNetworks)

Filter TV shows to include a specific network. Use the WithBuilder to generate the list,e.g. new WithBuilder(1).and(2).and(3)

Parameters:

withNetworks -

Returns: