Package dev.reuss.tmdb.domain.search.query

Class SearchMovieQuery

java.lang.Object

dev.reuss.tmdb.domain.search.query.SearchMovieQuery

All Implemented Interfaces:

SearchQuery, PagedQuery<SearchMovieQuery>, TmdbQuery, Serializable

public final class SearchMovieQuery
extends Object
implements SearchQuery, PagedQuery<SearchMovieQuery>

Query parameters for searching TMDB movies.

The search text is required and must not be blank. Optional filters are adult content inclusion, language, page, region, year and primary release year. Page and year filters are validated before serialization.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
SearchMovieQuery	includeAdult(Boolean includeAdult)
SearchMovieQuery	language(Language language)
static SearchMovieQuery	of(String query)
SearchMovieQuery	page(Integer page)	Sets the requested result page.
SearchMovieQuery	primaryReleaseYear(String primaryReleaseYear)
String	query()
SearchMovieQuery	region(Region region)
QueryParams	toQueryParams()
SearchMovieQuery	year(String year)

Methods inherited from class java.lang.Object

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

Method Details

of

public static SearchMovieQuery of(String query)

query

public String query()

Specified by:

query in interface SearchQuery

includeAdult

public SearchMovieQuery includeAdult(Boolean includeAdult)

language

public SearchMovieQuery language(Language language)

primaryReleaseYear

public SearchMovieQuery primaryReleaseYear(String primaryReleaseYear)

page

public SearchMovieQuery page(Integer page)

Description copied from interface: PagedQuery

Sets the requested result page.

Specified by:

page in interface PagedQuery<SearchMovieQuery>

Parameters:

page - page number, starting at 1

Returns:

the query instance

region

public SearchMovieQuery region(Region region)

year

public SearchMovieQuery year(String year)

toQueryParams

public QueryParams toQueryParams()

Specified by:

toQueryParams in interface TmdbQuery