org.broadleafcommerce.openadmin.client.dto

Class FilterAndSortCriteria

java.lang.Object

org.broadleafcommerce.openadmin.client.dto.FilterAndSortCriteria

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, Serializable

public class FilterAndSortCriteria
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable, Serializable

Basic client-side persistent entity criteria representation for a single property of the target persistent entity.

This class is essentially an analogy of server-side property criteria regarding the filtering and sorting functionality.

Back on the server side, persistent entity property mappings are used to resolve:

• symbolic persistent entity property identifier (propertyId) into the corresponding associationPath / targetPropertyName combination
• array of string-based filter values into appropriate typed object representations (integers, dates, etc.)

Note that the propertyId of each FilterAndSortCriteria instance must be unique within the CriteriaTransferObject.

Author:

vojtech.szocs

See Also:

CriteriaTransferObject, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterAndSortCriteria() Creates a new persistent entity criteria (for deserialization purposes only).
	FilterAndSortCriteria(String propertyId) Creates a new persistent entity criteria.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearFilterValues() Clears any filter value(s) set previously to this criteria.
String[]	getFilterValues()
Boolean	getIgnoreCase()
String	getPropertyId()
Boolean	getSortAscending()
void	setFilterValue(String value) Sets a single filter value to this criteria, replacing any filter value(s) set previously.
void	setFilterValues(String... values) Sets multiple filter values to this criteria, replacing any filter value(s) set previously.
void	setIgnoreCase(Boolean ignoreCase)
void	setSortAscending(Boolean sortAscending)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterAndSortCriteria

protected FilterAndSortCriteria()

Creates a new persistent entity criteria (for deserialization purposes only).

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId)

Creates a new persistent entity criteria.

Parameters:

propertyId - Symbolic persistent entity property identifier.

Method Detail

getPropertyId

public String getPropertyId()

Returns:

Symbolic persistent entity property identifier.

getFilterValues

public String[] getFilterValues()

Returns:

Array of string-based filter values.

clearFilterValues

public void clearFilterValues()

Clears any filter value(s) set previously to this criteria.

setFilterValue

public void setFilterValue(String value)

Sets a single filter value to this criteria, replacing any filter value(s) set previously.

Parameters:

value - String-based filter value.

setFilterValues

public void setFilterValues(String... values)

Sets multiple filter values to this criteria, replacing any filter value(s) set previously.

Parameters:

values - String-based filter values.

getSortAscending

public Boolean getSortAscending()

Returns:

true for ascending, false for descending sort order or null to disable the sorting functionality.

setSortAscending

public void setSortAscending(Boolean sortAscending)

Parameters:

sortAscending - true for ascending, false for descending sort order or null to disable the sorting functionality.

getIgnoreCase

public Boolean getIgnoreCase()

Returns:

true for case-insensitive sorting, false for case-sensitive sorting (applicable only when sortAscending is not null).

setIgnoreCase

public void setIgnoreCase(Boolean ignoreCase)

Parameters:

ignoreCase - true for case-insensitive sorting, false for case-sensitive sorting (applicable only when sortAscending is not null).