ThinkUI SQL Client 1.1.3 API

thinkui.common
Class SearchCriteriaData

java.lang.Object
  extended bythinkui.db.AbstractDataObject
      extended bythinkui.common.SearchCriteriaData
All Implemented Interfaces:
thinkui.common.CaptionSupport, thinkui.common.ClassNameSupport, java.lang.Cloneable, java.lang.Comparable, thinkui.db.DataClassSupport, DataObject, java.io.Serializable
Direct Known Subclasses:
DataAttrConsSearchData, DataAttributeSearchData, DataAttrTypeSearchData, DataClassSearchData, DataModelSearchData, DataRelationshipSearchData, DbConnectionSearchData, DbVersionSearchData, FilterSearchData, ProjectSearchData, QuerySearchData, TemplateFileSearchData

public class SearchCriteriaData
extends thinkui.db.AbstractDataObject

This is the base class for all client search criteria data. It serves as a value object for passing search criteria data to the business tier.

SearchCriteriaData objects are used to passed search criteria and other search parameters from the client to the server to perform searches. The search result is returned in the SearchResultsData objects.

See Also:
Serialized Form

Field Summary
static DataClass DATA_CLASS
           
static java.lang.String INCLUDE_NULLS
           
static java.lang.String MAX_OBJECT_COUNT
           
static Attribute MAX_OBJECT_COUNT_ATTRIBUTE
           
static java.lang.String OBJECT_COUNT
           
static java.lang.String ORDER_BY
           
static java.lang.String PERFORM_COUNT_ONLY
           
static java.lang.String START_INDEX
           
static Attribute START_INDEX_ATTRIBUTE
           
static java.lang.String TO_UPPER_CASE
           
static java.lang.String TRIM_STRINGS
           
static java.lang.String USE_LIKE
           
 
Fields inherited from interface thinkui.db.DataObject
INDEX_SEPARATOR, NAME_SEPARATOR
 
Constructor Summary
SearchCriteriaData()
          SearchCriteriaData constructor.
 
Method Summary
 DataClass getDataClass()
           
 int getMaxObjectCount()
           
 int getObjectCount()
           
 thinkui.db.OrderBy getOrderBy()
           
 int getStartIndex()
           
 boolean isIncludeNulls(boolean defaultValue)
           
 boolean isPerformCountOnly()
           
 boolean isToUpperCase(boolean defaultValue)
           
 boolean isTrimStrings(boolean defaultValue)
           
 boolean isUseLike(boolean defaultValue)
           
 void setIncludeNulls(boolean includeNulls)
          Sets whether or not to use the IS_NULL operator for null values.
 void setMaxObjectCount(int maxObjectCount)
          Sets the maximum number of objects to be returned from a search.
 void setObjectCount(int objectCount)
          Sets the maximum number of objects to be returned from a search.
 void setOrderBy(thinkui.db.OrderBy orderBy)
          Sets the order by for the search criteria data.
 void setPerformCountOnly(boolean performCountOnly)
          Sets whether or not to perform a count of the search result only.
 void setStartIndex(int startIndex)
          Sets the start index used for searching.
 void setToUpperCase(boolean toUpperCase)
          Sets whether or not to convert values to uppercase for STRING attribute type.
 void setTrimStrings(boolean trimStrings)
          Sets whether or not to trim values to uppercase for STRING attribute type.
 void setUseLike(boolean useLike)
          Sets whether or not to use the LIKE operator for STRING attribute type.
 
Methods inherited from class thinkui.db.AbstractDataObject
clearValue, clearValues, compareTo, copy, copyFrom, copyFrom, copyFrom, copyNonEmptyValuesFrom, equals, getAsString, getAttribute, getBigDecimal, getBigInteger, getBoolean, getCaption, getCharacter, getDate, getInteger, getLong, getModifiedAttrNames, getName, getNumber, getObjectClassName, getPersistentState, getPrimaryKey, getShort, getString, getTimestamp, getValue, getValuesMap, hashCode, initFrom, initFrom, initFrom, initValue, isAttribute, isModified, isModified, isNew, isOverridden, isReadOnly, isReadOnly, isValueEmpty, isValueSet, override, setModifiedAttrNames, setName, setPersistentState, setReadOnly, setValue, setValuesMap, toString, validate
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DATA_CLASS

public static final DataClass DATA_CLASS

INCLUDE_NULLS

public static final java.lang.String INCLUDE_NULLS
See Also:
Constant Field Values

MAX_OBJECT_COUNT

public static final java.lang.String MAX_OBJECT_COUNT
See Also:
Constant Field Values

MAX_OBJECT_COUNT_ATTRIBUTE

public static final Attribute MAX_OBJECT_COUNT_ATTRIBUTE

OBJECT_COUNT

public static final java.lang.String OBJECT_COUNT
See Also:
Constant Field Values

ORDER_BY

public static final java.lang.String ORDER_BY
See Also:
Constant Field Values

PERFORM_COUNT_ONLY

public static final java.lang.String PERFORM_COUNT_ONLY
See Also:
Constant Field Values

START_INDEX

public static final java.lang.String START_INDEX
See Also:
Constant Field Values

START_INDEX_ATTRIBUTE

public static final Attribute START_INDEX_ATTRIBUTE

TO_UPPER_CASE

public static final java.lang.String TO_UPPER_CASE
See Also:
Constant Field Values

TRIM_STRINGS

public static final java.lang.String TRIM_STRINGS
See Also:
Constant Field Values

USE_LIKE

public static final java.lang.String USE_LIKE
See Also:
Constant Field Values
Constructor Detail

SearchCriteriaData

public SearchCriteriaData()
SearchCriteriaData constructor.

Method Detail

getDataClass

public DataClass getDataClass()

getMaxObjectCount

public final int getMaxObjectCount()
Returns:
the maximum number of objects to be returned from a search (-1 indicates no limit).

getObjectCount

public final int getObjectCount()
Returns:
the object count returned from a search (-1 indicates count is unknown).

getOrderBy

public final thinkui.db.OrderBy getOrderBy()
Returns:
the order by for the search criteria data or null.

getStartIndex

public final int getStartIndex()
Returns:
the start index used for searching (0 is default).

isIncludeNulls

public final boolean isIncludeNulls(boolean defaultValue)
Returns:
whether or not to use the IS_NULL operator for null values or defaultValue.

isPerformCountOnly

public final boolean isPerformCountOnly()
Returns:
whether or not to perform a count of the search result only.

isToUpperCase

public final boolean isToUpperCase(boolean defaultValue)
Returns:
whether or not to convert values to uppercase for STRING attribute type or defaultValue.

isTrimStrings

public final boolean isTrimStrings(boolean defaultValue)
Returns:
whether or not to trim values to uppercase for STRING attribute type or defaultValue.

isUseLike

public final boolean isUseLike(boolean defaultValue)
Returns:
whether or not to use the LIKE operator for STRING attribute type or defaultValue.

setIncludeNulls

public final void setIncludeNulls(boolean includeNulls)
Sets whether or not to use the IS_NULL operator for null values.


setMaxObjectCount

public final void setMaxObjectCount(int maxObjectCount)
Sets the maximum number of objects to be returned from a search.


setObjectCount

public final void setObjectCount(int objectCount)
Sets the maximum number of objects to be returned from a search.


setOrderBy

public final void setOrderBy(thinkui.db.OrderBy orderBy)
Sets the order by for the search criteria data.


setPerformCountOnly

public final void setPerformCountOnly(boolean performCountOnly)
Sets whether or not to perform a count of the search result only.


setStartIndex

public final void setStartIndex(int startIndex)
Sets the start index used for searching.


setToUpperCase

public final void setToUpperCase(boolean toUpperCase)
Sets whether or not to convert values to uppercase for STRING attribute type.


setTrimStrings

public final void setTrimStrings(boolean trimStrings)
Sets whether or not to trim values to uppercase for STRING attribute type.


setUseLike

public final void setUseLike(boolean useLike)
Sets whether or not to use the LIKE operator for STRING attribute type.


ThinkUI SQL Client 1.1.3 API

Copyright © 2007-2009. ThinkUI Software Inc. All rights reserved.