Package com.inductiveautomation.ignition.gateway.dataroutes

Class FilterSortPageHelper.Builder<T>

java.lang.Object

com.inductiveautomation.ignition.gateway.dataroutes.FilterSortPageHelper.Builder<T>

Enclosing class:

FilterSortPageHelper<T>

public static class FilterSortPageHelper.Builder<T>
extends Object

Method Summary

Modifier and Type	Method	Description
FilterSortPageHelper<T>	build()
FilterSortPageHelper.Builder<T>	filter(String fieldName, FilterSortPageHelper.Operator operator, Object test)
FilterSortPageHelper.Builder<T>	limit(int limit)	Used to limit the resulting item set to the given number.
FilterSortPageHelper.Builder<T>	offset(int offset)	Used to skip the first N items, most often used for paging.
FilterSortPageHelper.Builder<T>	search(String query)
FilterSortPageHelper.Builder<T>	sortBy(String fieldName, boolean asc)	Add a sorted field.

Methods inherited from class java.lang.Object

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

Method Details

limit

public FilterSortPageHelper.Builder<T> limit(int limit)

Used to limit the resulting item set to the given number. By default, this will be set to -1, meaning no limit.

offset

public FilterSortPageHelper.Builder<T> offset(int offset)

Used to skip the first N items, most often used for paging. By default, this is set to zero.

search

public FilterSortPageHelper.Builder<T> search(String query)

sortBy

public FilterSortPageHelper.Builder<T> sortBy(String fieldName,
 boolean asc)

Add a sorted field. The field's value must be a Comparable.

Parameters:

fieldName - The name of the field. The field resolver will be used to extract the field value from object instances.

asc - True means ascending, False means descending.

filter

public FilterSortPageHelper.Builder<T> filter(String fieldName,
 FilterSortPageHelper.Operator operator,
 Object test)

build

public FilterSortPageHelper<T> build()