com.plumtree.server
Interface IPTSearchQuery

All Superinterfaces:
IPTUnknown

public interface IPTSearchQuery
extends IPTUnknown

Interface that encapsulates one search query; used with (and manufactured by) IPTSearchRequest. This interface has several portal implementations, including a simple text search query, an advanced property filter-based query, and various forms of queries associated with drilling down into categories generated as part of a previous search result.

Clients of the search interface usually do not need to call any of the methods on this interface. Search queries are manufactured by an IPTSearchRequest and are basically opaque to clients.

Version:
$Revision$
Author:
CraigS
See Also:
IPTSearchRequest

Method Summary
 IPTFilter GetContentAsIPTFilter()
          Returns an IPTFilter that corresponds to this search query.
 java.lang.String GetContentAsString()
          Returns this search query as a simple string.
 java.lang.Object GetRFQuery()
          Returns an OpenKernelSearch object that encapsulates this query.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetRFQuery

java.lang.Object GetRFQuery()
Returns an OpenKernelSearch object that encapsulates this query. Client code should not call this method; it is used by IPTSearchRequest.

Returns:
an Object needed by OpenKernelSearch or the search API

GetContentAsIPTFilter

IPTFilter GetContentAsIPTFilter()
Returns an IPTFilter that corresponds to this search query. If the query cannot be represented as a filter, may return null or throw an exception, depending on implementation (be prepared to handle either case).

Returns:
a filter corresponding to the query

GetContentAsString

java.lang.String GetContentAsString()
Returns this search query as a simple string. If the query is too complex to be represented as a string, may return null or throw an exception, depending on implementation (be prepared to handle either case).

Returns:
a string corresponding to the query


Copyright 2008 Plumtree Software Inc. All Rights Reserved.