Package com.treescrub.spedran.requests.builders.series

Class AllSeriesRequest

java.lang.Object

com.treescrub.spedran.ResourceCollectionRequest<Series>

com.treescrub.spedran.requests.builders.series.AllSeriesRequest

public class AllSeriesRequest
extends ResourceCollectionRequest<Series>

A request builder to get all Series matching the set filters.

Constructor Summary

Constructors

Constructor	Description
AllSeriesRequest()

Method Summary

Modifier and Type	Method	Description
AllSeriesRequest	abbreviation(String abbreviation)	Search for an exact series abbreviation.
AllSeriesRequest	moderator(User user)	Restricts the results to series moderated by the given User.
AllSeriesRequest	moderator(String id)	Restricts the results to series moderated by the given User.
AllSeriesRequest	name(String name)	Use a fuzzy search to filter series names and abbreviations.
AllSeriesRequest	sortByAbbreviation()	Sorts the results alphanumerically by the abbreviation of the series.
AllSeriesRequest	sortByCreationDate()	Sorts the results by the creation time of the series on SRC.
AllSeriesRequest	sortByInternationalName()	Sorts the results alphanumerically by the international name of the series.
AllSeriesRequest	sortByJapaneseName()	Sorts the results alphanumerically by the Japanese name of the series.
AllSeriesRequest	sortDirection(SortDirection direction)	Sets the direction (ascending or descending) of the sorting.

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest

complete

Methods inherited from class java.lang.Object

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

Constructor Detail

AllSeriesRequest

public AllSeriesRequest()

Method Detail

name

public AllSeriesRequest name(String name)

Use a fuzzy search to filter series names and abbreviations.

Parameters:

name - the String to search for

Returns:

this AllSeriesRequest builder

abbreviation

public AllSeriesRequest abbreviation(String abbreviation)

Search for an exact series abbreviation.

Parameters:

abbreviation - the abbreviation to search for

Returns:

this AllSeriesRequest builder

moderator

public AllSeriesRequest moderator(String id)

Restricts the results to series moderated by the given User.

Parameters:

id - the user ID

Returns:

this AllSeriesRequest builder

moderator

public AllSeriesRequest moderator(User user)

Restricts the results to series moderated by the given User.

Parameters:

user - the user

Returns:

this AllSeriesRequest builder

sortByInternationalName

public AllSeriesRequest sortByInternationalName()

Sorts the results alphanumerically by the international name of the series.

Returns:

this AllSeriesRequest builder

sortByJapaneseName

public AllSeriesRequest sortByJapaneseName()

Sorts the results alphanumerically by the Japanese name of the series.

Returns:

this AllSeriesRequest builder

sortByAbbreviation

public AllSeriesRequest sortByAbbreviation()

Sorts the results alphanumerically by the abbreviation of the series.

Returns:

this AllSeriesRequest builder

sortByCreationDate

public AllSeriesRequest sortByCreationDate()

Sorts the results by the creation time of the series on SRC.

Returns:

this AllSeriesRequest builder

sortDirection

public AllSeriesRequest sortDirection(SortDirection direction)

Sets the direction (ascending or descending) of the sorting.

Parameters:

direction - the sort direction

Returns:

this AllSeriesRequest builder