Aqualogic Interaction API  
 

IPTSQueryResponse Members

IPTSQueryResponse overview

Public Instance Methods

clear Clears this object and releases references to any result set. Calling this method as soon as you are done with the object may promote more efficient garbage collection. After this method is called, no more methods should be called on the object.
getAllOthersGroup Returns information about items that could not be categorized into any of the groups returned by getGroups.
getCompleteQuery 
getFirstResultIndex Returns the index of the first result that is part of this response (1-based). (If the results page says "Results 11-20 of 43", this method returns 11.)
getGroups 
getResults Returns an enumeration of the actual results that matched the query. Elements are of type IPTSResult; the number of items in this enumeration is equal to the value returned by getReturnedCount.
getReturnedCount Returns the number of results returned as part of this response. (If the results page says "Results 11-20 of 43", this method returns 10.)
getSpellingCorrections Returns spelling corrections applied as part of the request. May be null or an empty array if there are no corrections.
getTotalCount Returns the total number of items in the search server that matched the query; not all were necessarily returned. (If the results page says "Results 11-20 of 43", this method returns 43.)
queryIsPartial Returns true if the query was executed on a partial search cluster(some nodes were down).
queryTimedOut Returns true if the request took too much time to run and a partial result set was returned. Note that no exception is thrown in this case; the Search Server simply returns an incomplete result set, and you may wish to display a message to the user indicating this. Also, note that this method is not meant to be called during execution of the request (after all, this IPTSQueryResponse object has not yet been constructed); you should call it after IPTSQueryRequest.execute returns, to determine whether execution completed or not.
wildcardExpansionIncomplete Returns true if processing of a wildcarded query term (e.g. "p*") took too long or yielded too many possibilities to consider; ; in this case a subset of the possible wildcard matches were actually used for the query, and an incomplete result set is returned. You may wish to display a message to the end-user indicating that this happened.

See Also

IPTSQueryResponse Interface | com.plumtree.server.search Namespace