com.iphrase.runtime.query.result
Class QueryResult

java.lang.Object
  |
  +--com.iphrase.runtime.query.result.QueryResult

public class QueryResult
extends java.lang.Object

Represent the response from Query.execute().


Constructor Summary
QueryResult(com.iphrase.www._2003._11.oneStep.encodedTypes.SearchResult result)
          Construct a QueryResult from a proxy query result struct (from Axis WSDL2Java).
 
Method Summary
 java.util.Hashtable getAttributes()
          Get the attributes hash table.
 ResultSet[] getDirectResultSets()
          Get any direct nav or direct answer (presentation rank > 1) result sets.
 java.util.Hashtable getHooks()
          Get the hooks hash table.
 ResultSet getMainResultSet()
          Get the main (presentation rank == 1) result set.
 ResultSet[] getOtherResultSets()
          Get any other (presentation rank > 1) result sets that are neither main nor direct.
 java.lang.String getRedirectLocation()
          The URL to redirect to, or empty string if no redirection is required.
 ResultSet[] getResultSets()
          Get all of the ResultSet instances.
 java.lang.String[] getSourceOptions()
          Get the source options for this result set.
 int getSourceSelected()
          Get the index of the currently selected source option.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryResult

public QueryResult(com.iphrase.www._2003._11.oneStep.encodedTypes.SearchResult result)
            throws WebServiceError
Construct a QueryResult from a proxy query result struct (from Axis WSDL2Java).
Parameters:
result - proxy class value
Method Detail

getMainResultSet

public ResultSet getMainResultSet()
Get the main (presentation rank == 1) result set. This result set is also in the array returned by getResultSets().

Currently, there is always one and only one rank 1 result set. If future versions allow more than one, this method will return null.

Returns:
ResultSet main result set.

getDirectResultSets

public ResultSet[] getDirectResultSets()
Get any direct nav or direct answer (presentation rank > 1) result sets. These result sets are also in the array returned by getResultSets().
Returns:
ResultSet array

getOtherResultSets

public ResultSet[] getOtherResultSets()
Get any other (presentation rank > 1) result sets that are neither main nor direct. These typically correspond to business ("biz") rules. These result sets are also in the array returned by getResultSets().
Returns:
ResultSet array

getResultSets

public ResultSet[] getResultSets()
Get all of the ResultSet instances.
Returns:
ResultSet array

getSourceOptions

public java.lang.String[] getSourceOptions()
Get the source options for this result set. Source options can be used to restrict a query to a single search source (domain), and are only available for multi-source deployments. This operation is currently unsupported.
Returns:
Feature array or null if there are no source options for this result set

getSourceSelected

public int getSourceSelected()
Get the index of the currently selected source option. This operation is currently unsupported.
Returns:
int option index, or -1 if no option is selected
See Also:
getSourceOptions()

getHooks

public java.util.Hashtable getHooks()
Get the hooks hash table. All values are String.
Returns:
Hashtable key/value pairs of custom data set by hooks

getAttributes

public java.util.Hashtable getAttributes()
Get the attributes hash table. All values are String.
Returns:
Hashtable key/value pairs of query result attributes

getRedirectLocation

public java.lang.String getRedirectLocation()
The URL to redirect to, or empty string if no redirection is required.
Returns:
Document URL

© Copyright 2005, 2006. IBM Corporation. All rights reserved.