ThinkUI SQL Client 1.1.3 API

thinkui.common
Class SearchResultsData

java.lang.Object
  extended bythinkui.common.SearchResultsData
All Implemented Interfaces:
java.io.Serializable

public class SearchResultsData
extends java.lang.Object
implements java.io.Serializable

This class encapsulation information about a search results.

See Also:
Serialized Form

Constructor Summary
SearchResultsData()
          SearchResultsData constructor.
SearchResultsData(java.util.List objects)
          SearchResultsData constructor.
 
Method Summary
 int getCount()
          Return the number of objects that matches the search criteria.
 DataClass getDataClass()
           
 java.lang.String getDescription()
           
 java.util.List getObjects()
           
 int getStartIndex()
           
 boolean hasMoreObjects()
           
 boolean hasObjects()
          Convenience method to return whether or not the search data results has any objects.
 void setCount(int searchCount)
          Sets the number of objects that matches the search criteria or -1 if unknown.
 void setDataClass(DataClass dataClass)
          Sets the data class of the selected objects.
 void setDescription(java.lang.String description)
          Sets the description of the search results.
 void setMoreObjects(boolean moreObjects)
          Sets whether or not there are more objects not returned in the search results.
 void setObjects(java.util.List objects)
          Sets the list of objects in the search result.
 void setStartIndex(int startIndex)
          Sets the start index of the search result.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchResultsData

public SearchResultsData()
SearchResultsData constructor.


SearchResultsData

public SearchResultsData(java.util.List objects)
SearchResultsData constructor.

Method Detail

getCount

public final int getCount()
Return the number of objects that matches the search criteria. This number may be larger than the size of the list of objects returned. If the total search count is unknown, -1 will be returned.

Returns:
the search count based on the search criteria or -1 (unknown).

getDataClass

public final DataClass getDataClass()
Returns:
the data class of the selected objects or null.

getDescription

public final java.lang.String getDescription()
Returns:
the description of the search results or null.

getObjects

public final java.util.List getObjects()
Returns:
the list of objects in the search result or null.

getStartIndex

public final int getStartIndex()
Returns:
the start index of the search result.

hasMoreObjects

public final boolean hasMoreObjects()
Returns:
whether or not there are more objects not returned in the search results.

hasObjects

public final boolean hasObjects()
Convenience method to return whether or not the search data results has any objects.


setCount

public final void setCount(int searchCount)
Sets the number of objects that matches the search criteria or -1 if unknown. This number may be larger than the size of the list of objects returned.


setDataClass

public final void setDataClass(DataClass dataClass)
Sets the data class of the selected objects.


setDescription

public final void setDescription(java.lang.String description)
Sets the description of the search results.


setMoreObjects

public final void setMoreObjects(boolean moreObjects)
Sets whether or not there are more objects not returned in the search results.


setObjects

public final void setObjects(java.util.List objects)
Sets the list of objects in the search result.


setStartIndex

public final void setStartIndex(int startIndex)
Sets the start index of the search result.


toString

public final java.lang.String toString()

ThinkUI SQL Client 1.1.3 API

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