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

Class SearchCollectionQuery

java.lang.Object

dev.reuss.tmdb.domain.search.query.SearchCollectionQuery

All Implemented Interfaces:

SearchQuery, PagedQuery<SearchCollectionQuery>, TmdbQuery, Serializable

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

Query parameters for searching TMDB collections.

The search text is required and must not be blank. Optional filters are adult content inclusion, language, page and region. Page values are validated by QueryValidation.validatePage(Integer).

See Also:

• Serialized Form

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

of

public static SearchCollectionQuery of(String query)

query

public String query()

Specified by:

query in interface SearchQuery

includeAdult

public SearchCollectionQuery includeAdult(Boolean includeAdult)

language

public SearchCollectionQuery language(Language language)

page

public SearchCollectionQuery page(Integer page)

Description copied from interface: PagedQuery

Sets the requested result page.

Specified by:

page in interface PagedQuery<SearchCollectionQuery>

Parameters:

page - page number, starting at 1

Returns:

the query instance

region

public SearchCollectionQuery region(Region region)

toQueryParams

public QueryParams toQueryParams()

Specified by:

toQueryParams in interface TmdbQuery