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

Class SearchPersonQuery

java.lang.Object

dev.reuss.tmdb.domain.search.query.SearchPersonQuery

All Implemented Interfaces:

SearchQuery, PagedQuery<SearchPersonQuery>, TmdbQuery, Serializable

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

Query parameters for searching TMDB people.

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

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
SearchPersonQuery	includeAdult(Boolean includeAdult)
SearchPersonQuery	language(Language language)
static SearchPersonQuery	of(String query)
SearchPersonQuery	page(Integer page)	Sets the requested result page.
String	query()
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 SearchPersonQuery of(String query)

query

public String query()

Specified by:

query in interface SearchQuery

includeAdult

public SearchPersonQuery includeAdult(Boolean includeAdult)

language

public SearchPersonQuery language(Language language)

page

public SearchPersonQuery page(Integer page)

Description copied from interface: PagedQuery

Sets the requested result page.

Specified by:

page in interface PagedQuery<SearchPersonQuery>

Parameters:

page - page number, starting at 1

Returns:

the query instance

toQueryParams

public QueryParams toQueryParams()

Specified by:

toQueryParams in interface TmdbQuery