com.quickblox.core.request

Class QBRequestGetBuilder

java.lang.Object

QBRequestBuilder

com.quickblox.core.request.QBLimitedRequestBuilder

com.quickblox.core.request.QBRequestGetBuilder

Direct Known Subclasses:

QBMessageGetBuilder

public class QBRequestGetBuilder
extends QBLimitedRequestBuilder

The QBRequestGetBuilder allows to set parameters for a get/search request. More info about search filters.

Constructor Summary

Constructors

Constructor and Description
QBRequestGetBuilder() Constructs a new QBRequestGetBuilder object

Method Summary

Modifier and Type	Method and Description
QBRequestGetBuilder	addRule(java.lang.String fieldName, java.lang.String rule, java.lang.Object value) Add a custom search rule to the request.
QBRequestGetBuilder	all(java.lang.String fieldName, java.lang.Object... values) ALL contained IN array operator
protected java.lang.String	arrayToString(java.lang.Object... values)
QBRequestGetBuilder	count() Count operator.
QBRequestGetBuilder	ctn(java.lang.String fieldName, java.lang.Object value) CONTAINS operator
QBRequestGetBuilder	eq(java.lang.String fieldName, java.lang.Object value) Equal to operator
QBRequestGetBuilder	gt(java.lang.String fieldName, java.lang.Object value) Greater Than operator
QBRequestGetBuilder	gte(java.lang.String fieldName, java.lang.Object value) Greater Than or Equal operator
QBRequestGetBuilder	in(java.lang.String fieldName, java.lang.Object... values) Contained IN array operator
QBRequestGetBuilder	lt(java.lang.String fieldName, java.lang.Object value) Less Than operator
QBRequestGetBuilder	lte(java.lang.String fieldName, java.lang.Object value) Less Than or Equal operator
QBRequestGetBuilder	ne(java.lang.String fieldName, java.lang.Object value) Not Equal to operator
QBRequestGetBuilder	near(java.lang.String fieldName, java.lang.Double[] location, int radius) Search records in a specific radius with current position in meters.
QBRequestGetBuilder	nin(java.lang.String fieldName, java.lang.Object... values) Not contained IN array operator
QBRequestGetBuilder	or(java.lang.String fieldName, java.lang.Object... values) OR operator
QBRequestGetBuilder	output(java.util.List<java.lang.String> values) Deprecated. Use 'outputInclude' method instead
QBRequestGetBuilder	outputExclude(java.util.List<java.lang.String> values) The operator specifies which fields to exclude from a result set.
QBRequestGetBuilder	outputInclude(java.util.List<java.lang.String> values) The operator specifies which fields to include to a result set.
QBRequestGetBuilder	sortAsc(java.lang.String fieldName) Sort by specified field in ascending order
QBRequestGetBuilder	sortDesc(java.lang.String fieldName) Sort by specified field in descending order

Methods inherited from class com.quickblox.core.request.QBLimitedRequestBuilder

getLimit, getPagesLimit, getPagesSkip, getSkip, setLimit, setPagesLimit, setPagesSkip, setSkip

Methods inherited from class java.lang.Object

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

Constructor Detail

QBRequestGetBuilder

public QBRequestGetBuilder()

Constructs a new QBRequestGetBuilder object

Method Detail

addRule

public QBRequestGetBuilder addRule(java.lang.String fieldName,
                                   java.lang.String rule,
                                   java.lang.Object value)

Add a custom search rule to the request.

Parameters:

fieldName - The field name to apply the operator for

rule - The rule (eg: "le")

value - The rule value (eg: 50)

Returns:

QBRequestGetBuilder instance

lt

public QBRequestGetBuilder lt(java.lang.String fieldName,
                              java.lang.Object value)

Less Than operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

lte

public QBRequestGetBuilder lte(java.lang.String fieldName,
                               java.lang.Object value)

Less Than or Equal operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

gt

public QBRequestGetBuilder gt(java.lang.String fieldName,
                              java.lang.Object value)

Greater Than operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

gte

public QBRequestGetBuilder gte(java.lang.String fieldName,
                               java.lang.Object value)

Greater Than or Equal operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

all

public QBRequestGetBuilder all(java.lang.String fieldName,
                               java.lang.Object... values)

ALL contained IN array operator

Parameters:

fieldName - The field name to apply the operator for

values - The operator values

Returns:

QBRequestGetBuilder instance

in

public QBRequestGetBuilder in(java.lang.String fieldName,
                              java.lang.Object... values)

Contained IN array operator

Parameters:

fieldName - The field name to apply the operator for

values - The operator values

Returns:

QBRequestGetBuilder instance

nin

public QBRequestGetBuilder nin(java.lang.String fieldName,
                               java.lang.Object... values)

Not contained IN array operator

Parameters:

fieldName - The field name to apply the operator for

values - The operator values

Returns:

QBRequestGetBuilder instance

or

public QBRequestGetBuilder or(java.lang.String fieldName,
                              java.lang.Object... values)

OR operator

Parameters:

fieldName - The field name to apply the operator for

values - The operator values

Returns:

QBRequestGetBuilder instance

ctn

public QBRequestGetBuilder ctn(java.lang.String fieldName,
                               java.lang.Object value)

CONTAINS operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

ne

public QBRequestGetBuilder ne(java.lang.String fieldName,
                              java.lang.Object value)

Not Equal to operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

eq

public QBRequestGetBuilder eq(java.lang.String fieldName,
                              java.lang.Object value)

Equal to operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestGetBuilder instance

count

public QBRequestGetBuilder count()

Count operator. Response will contain only count of records found.

Returns:

QBRequestGetBuilder instance

sortAsc

public QBRequestGetBuilder sortAsc(java.lang.String fieldName)

Sort by specified field in ascending order

Parameters:

fieldName - The field name to sort by

Returns:

QBRequestGetBuilder instance

sortDesc

public QBRequestGetBuilder sortDesc(java.lang.String fieldName)

Sort by specified field in descending order

Parameters:

fieldName - The field name to sort by

Returns:

QBRequestGetBuilder instance

output

@Deprecated
public QBRequestGetBuilder output(java.util.List<java.lang.String> values)

Deprecated. Use 'outputInclude' method instead

The operator specifies which fields to include to a result set.

Parameters:

values - The list of fields to include to a result set

Returns:

QBRequestGetBuilder instance

outputInclude

public QBRequestGetBuilder outputInclude(java.util.List<java.lang.String> values)

The operator specifies which fields to include to a result set.

Parameters:

values - The list of fields to include to a result set

Returns:

QBRequestGetBuilder instance

outputExclude

public QBRequestGetBuilder outputExclude(java.util.List<java.lang.String> values)

The operator specifies which fields to exclude from a result set.

Parameters:

values - The list of fields to exclude from a result set

Returns:

QBRequestGetBuilder instance

near

public QBRequestGetBuilder near(java.lang.String fieldName,
                                java.lang.Double[] location,
                                int radius)

Search records in a specific radius with current position in meters.

Parameters:

fieldName - The name of 'Location type' field

location - The array with 2 elements in next order: first - longitude, second - latitude

radius - The search radius in meters

Returns:

QBRequestGetBuilder instance

arrayToString

protected java.lang.String arrayToString(java.lang.Object... values)