com.ibasco.agql.protocols.supercell.coc.webapi

Class CocSearchCriteria

java.lang.Object

com.ibasco.agql.protocols.supercell.coc.webapi.CocSearchCriteria

Deprecated.

@Deprecated
 @ApiStatus.ScheduledForRemoval
public class CocSearchCriteria
extends Object

A Builder class for Clan Search Criteria

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

Constructor and Description
CocSearchCriteria() Deprecated.

Method Summary

Modifier and Type	Method and Description
CocSearchCriteria	after(int after) Deprecated. Return only items that occur after this marker.
CocSearchCriteria	before(int before) Deprecated. Return only items that occur before this marker.
static CocSearchCriteria	create() Deprecated. A factory method to create a CocSearchCriteria instance
Set<Map.Entry<String,Object>>	getCriteriaSet() Deprecated. Returns the underlying set containing all the search criterias
CocSearchCriteria	limit(int limit) Deprecated. Limit the number of items returned in the response.
CocSearchCriteria	locationId(int locationId) Deprecated. Filter by clan location identifier.
CocSearchCriteria	maxMembers(int maxMembers) Deprecated. Filter by maximum amount of clan members.
CocSearchCriteria	minClanLevel(int minClanLevel) Deprecated. Filter by minimum clan level.
CocSearchCriteria	minClanPoints(int minClanPoints) Deprecated. Filter by minimum amount of clan points.
CocSearchCriteria	minMembers(int minMembers) Deprecated. Filter by minimum amount of clan members.
CocSearchCriteria	name(String name) Deprecated. Search clans by name.
CocSearchCriteria	warFrequency(CocWarFrequency frequency) Deprecated. Filter by clan war frequency

Methods inherited from class java.lang.Object

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

Constructor Detail

CocSearchCriteria

public CocSearchCriteria()

Deprecated.

Method Detail

create

public static CocSearchCriteria create()

Deprecated.

A factory method to create a CocSearchCriteria instance

Returns:

A CocSearchCriteria instance

name

public CocSearchCriteria name(String name)

Deprecated.

Search clans by name. If name is used as part of search query, it needs to be at least three characters long. Name search parameter is interpreted as wild card search, so it may appear anywhere in the clan name.

Parameters:

name - a String object

Returns:

A CocSearchCriteria instance

warFrequency

public CocSearchCriteria warFrequency(CocWarFrequency frequency)

Deprecated.

Filter by clan war frequency

Parameters:

frequency - a CocWarFrequency object

Returns:

A CocSearchCriteria instance

locationId

public CocSearchCriteria locationId(int locationId)

Deprecated.

Filter by clan location identifier. For list of available locations, refer to getLocations operation.

Parameters:

locationId - a int

Returns:

A CocSearchCriteria instance

minMembers

public CocSearchCriteria minMembers(int minMembers)

Deprecated.

Filter by minimum amount of clan members.

Parameters:

minMembers - a int

Returns:

A CocSearchCriteria instance

maxMembers

public CocSearchCriteria maxMembers(int maxMembers)

Deprecated.

Filter by maximum amount of clan members.

Parameters:

maxMembers - a int

Returns:

A CocSearchCriteria instance

minClanPoints

public CocSearchCriteria minClanPoints(int minClanPoints)

Deprecated.

Filter by minimum amount of clan points.

Parameters:

minClanPoints - a int

Returns:

A CocSearchCriteria instance

minClanLevel

public CocSearchCriteria minClanLevel(int minClanLevel)

Deprecated.

Filter by minimum clan level.

Parameters:

minClanLevel - a int

Returns:

A CocSearchCriteria instance

limit

public CocSearchCriteria limit(int limit)

Deprecated.

Limit the number of items returned in the response.

Parameters:

limit - a int

Returns:

A CocSearchCriteria instance

after

public CocSearchCriteria after(int after)

Deprecated.

Return only items that occur after this marker. After marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.

Parameters:

after - a int

Returns:

A CocSearchCriteria instance

before

public CocSearchCriteria before(int before)

Deprecated.

Return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.

Parameters:

before - a int

Returns:

A CocSearchCriteria instance

getCriteriaSet

public Set<Map.Entry<String,Object>> getCriteriaSet()

Deprecated.

Returns the underlying set containing all the search criterias

Returns:

A Set containing all the search criterias wrapped within a Map.Entry