DataListFilter

Method Summary
	addBetween(String column, String lower, String higher, String type) Return records where column is between the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A' and 'B' but not 'C'. For numbers, the end points are inclusive: between 1 and 5 will return 1,2,3,4 and 5.
	addContains(String column, String value) Return records where column contains value.
	addEqual(String column, String value) Return records where column equals value.
	addEqualIgnoreCase(String column, String value) Return records where column equals value, ignoring case.
	addGreaterThan(String column, String value, String type) Return records where column is greater than the value. The values will be cast to the specified type.
	addIsEmpty(String column) Return records where column value is empty.
	addIsNotEmpty(String column) Return records where column value is not empty.
	addIsNotNull(String column) Return records where column value is not null.
	addIsNull(String column) Return records where column value is null.
	addLessThan(String column, String value, String type) Return records where column is less than the value. The values will be cast to the specified type.
	addNotEqual(String column, String value) Return records where column is not equal to the value.
	isNotValid(String column, String type) Adds validation filter criteria. Records that are valid according to specified validator type will be removed from data list
	isValid(String column, String type) Adds validation filter criteria. Records that are valid according to specified validator type will be retained in data list
	setFirstRecord(int firstRecord) Set the first record to return.
	setPageSize(int size) Set the page size (max 1000, min 1, default 100).
	sortAscending(String column, String type) Sorts the results in ascending order on the given column.
	sortDescending(String column, String type) Sorts the results in descending order on the given column.
String	toString() Returns a description of this object.

Method Detail

addBetween(String column, String lower, String higher, String type)

Return records where column is between the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A' and 'B' but not 'C'. For numbers, the end points are inclusive: between 1 and 5 will return 1,2,3,4 and 5.

Parameters:

String column
String lower
String higher
String type Allowed values: string, date, number, boolean.

Since: 06-04-2008

top

addContains(String column, String value)

Return records where column contains value.

Parameters:

String column
String value

Since: 01-09-2009

top

addEqual(String column, String value)

Return records where column equals value.

Parameters:

String column
String value

Since: 06-04-2008

top

addEqualIgnoreCase(String column, String value)

Return records where column equals value, ignoring case.

Parameters:

String column Required parameter.
String value Required parameter.

Since: 05-01-2014

top

addGreaterThan(String column, String value, String type)

Return records where column is greater than the value. The values will be cast to the specified type.

Parameters:

String column
String value
String type Allowed values: string, date, number, boolean.

Since: 06-04-2008

top

addIsEmpty(String column)

Return records where column value is empty.

Parameters:

String column Required parameter.

Since: 05-28-2021

top

addIsNotEmpty(String column)

Return records where column value is not empty.

Parameters:

String column Required parameter.

Since: 05-28-2021

top

addIsNotNull(String column)

Return records where column value is not null.

Parameters:

String column Required parameter.

Since: 02-25-2011

top

addIsNull(String column)

Return records where column value is null.

Parameters:

String column Required parameter.

Since: 02-25-2011

top

addLessThan(String column, String value, String type)

Return records where column is less than the value. The values will be cast to the specified type.

Parameters:

String column
String value
String type Allowed values: string, date, number, boolean.

Since: 06-04-2008

top

addNotEqual(String column, String value)

Return records where column is not equal to the value.

Parameters:

String column
String value

Since: 06-04-2008

top

isNotValid(String column, String type)

Adds validation filter criteria. Records that are valid according to specified validator type will be removed from data list

Parameters:

String column - datalist column. Required parameter.
String type - validator type. Required parameter. Allowed values: email, number, date, sms, usCard, routingNumber, usPostalCode, domain, faxNumber.

Since: 04-12-2011

top

isValid(String column, String type)

Adds validation filter criteria. Records that are valid according to specified validator type will be retained in data list

Parameters:

String column - datalist column. Required parameter.
String type - validator type. Required parameter. Allowed values: email, number, date, sms, usCard, routingNumber, usPostalCode, domain, faxNumber.

Since: 04-12-2011

top

setFirstRecord(int firstRecord)

Set the first record to return.

Parameters: