com.anasoft.os.daofusion.cto.client
Class FilterAndSortCriteria

java.lang.Object
  extended by com.anasoft.os.daofusion.cto.client.FilterAndSortCriteria
All Implemented Interfaces:
java.io.Serializable

public class FilterAndSortCriteria
extends java.lang.Object
implements java.io.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:

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

Author:
vojtech.szocs
See Also:
CriteriaTransferObject, Serialized Form

Constructor Summary
protected FilterAndSortCriteria()
          Creates a new persistent entity criteria (for deserialization purposes only).
  FilterAndSortCriteria(java.lang.String propertyId)
          Creates a new persistent entity criteria.
 
Method Summary
 void clearFilterValues()
          Clears any filter value(s) set previously to this criteria.
 java.lang.String[] getFilterValues()
           
 java.lang.Boolean getIgnoreCase()
           
 java.lang.String getPropertyId()
           
 java.lang.Boolean getSortAscending()
           
 void setFilterValue(java.lang.String value)
          Sets a single filter value to this criteria, replacing any filter value(s) set previously.
 void setFilterValues(java.lang.String... values)
          Sets multiple filter values to this criteria, replacing any filter value(s) set previously.
 void setIgnoreCase(java.lang.Boolean ignoreCase)
           
 void setSortAscending(java.lang.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(java.lang.String propertyId)
Creates a new persistent entity criteria.

Parameters:
propertyId - Symbolic persistent entity property identifier.
Method Detail

getPropertyId

public java.lang.String getPropertyId()
Returns:
Symbolic persistent entity property identifier.

getFilterValues

public java.lang.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(java.lang.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(java.lang.String... values)
Sets multiple filter values to this criteria, replacing any filter value(s) set previously.

Parameters:
values - String-based filter values.

getSortAscending

public java.lang.Boolean getSortAscending()
Returns:
true for ascending, false for descending sort order or null to disable the sorting functionality.

setSortAscending

public void setSortAscending(java.lang.Boolean sortAscending)
Parameters:
sortAscending - true for ascending, false for descending sort order or null to disable the sorting functionality.

getIgnoreCase

public java.lang.Boolean getIgnoreCase()
Returns:
true for case-insensitive sorting, false for case-sensitive sorting (applicable only when sortAscending is not null).

setIgnoreCase

public void setIgnoreCase(java.lang.Boolean ignoreCase)
Parameters:
ignoreCase - true for case-insensitive sorting, false for case-sensitive sorting (applicable only when sortAscending is not null).


Copyright © 2008-2009 ANASOFT and contributors. All Rights Reserved.