|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTSearchRequest
IPTSearchRequest is the major interface used to run a search through the Plumtree portal; it contains factory methods for search queries, settings that govern all aspects of the search, and methods to actually execute the query.
The standard usage pattern for IPTSearchRequest is:
PT_SEARCH_SETTING
,
IPTSearchQuery
,
IPTSearchResponse
Method Summary | |
---|---|
IPTSearchQuery |
CreateAdvancedQuery(IPTFilter filter)
Factory method that returns an advanced (filter-based) query, using the provided filter. |
IPTSearchQuery |
CreateBasicQuery(java.lang.String searchString,
java.lang.String fields)
Factory method that returns a basic (simple text) query for the indicated search string and fields. |
IPTSearchResponse |
FollowupSearch(java.lang.Object queryArray)
Follow up a previous search by ANDing the provided array of queries together and executing them. |
int |
GetSettingsAsInt(int settingID)
Retrieve value of an integer-valued search setting. |
java.lang.Object |
GetSettingsAsObject(int settingID)
Retrieve value of any search setting. |
java.lang.Object[] |
GetSettingsAsObject1DArray(int settingID)
Retrieve value of an array-valued search setting. |
java.lang.String |
GetSettingsAsString(int settingID)
Retrieve value of an String-valued search setting. |
IPTSearchResponse |
Search(IPTSearchQuery pQuery)
Executes a search, using the provided query and any settings that have previously been set. |
void |
SetSettings(int settingId,
int settingValue)
Set an integer-valued search setting. |
void |
SetSettings(int settingId,
java.lang.Object settingValue)
Set a search setting (of any type). |
void |
SetSettings(int settingId,
java.lang.Object[] settingValue)
Set an array-valued (usually Integer[]) search setting. |
void |
SetSettings(int settingId,
java.lang.String settingValue)
Set a String-valued search setting. |
Methods inherited from interface com.plumtree.server.IPTUnknown |
---|
GetInterfaces |
Method Detail |
---|
int GetSettingsAsInt(int settingID)
settingID
- setting id whose value is desired; one of the PT_SEARCH_SETTING values
PT_SEARCH_SETTING
java.lang.String GetSettingsAsString(int settingID)
settingID
- setting id whose value is desired; one of the PT_SEARCH_SETTING values
PT_SEARCH_SETTING
java.lang.Object GetSettingsAsObject(int settingID)
settingID
- setting id whose value is desired; one of the PT_SEARCH_SETTING values
PT_SEARCH_SETTING
java.lang.Object[] GetSettingsAsObject1DArray(int settingID)
settingID
- setting id whose value is desired; one of the PT_SEARCH_SETTING values
PT_SEARCH_SETTING
void SetSettings(int settingId, int settingValue)
settingId
- setting id being set; one of the PT_SEARCH_SETTING valuessettingValue
- value to setPT_SEARCH_SETTING
void SetSettings(int settingId, java.lang.String settingValue)
settingId
- setting id being set; one of the PT_SEARCH_SETTING valuessettingValue
- value to setPT_SEARCH_SETTING
void SetSettings(int settingId, java.lang.Object settingValue)
settingId
- setting id being set; one of the PT_SEARCH_SETTING valuessettingValue
- value to setPT_SEARCH_SETTING
void SetSettings(int settingId, java.lang.Object[] settingValue)
settingId
- setting id being set; one of the PT_SEARCH_SETTING valuessettingValue
- value to setPT_SEARCH_SETTING
IPTSearchResponse Search(IPTSearchQuery pQuery)
query
- Query to execute
IPTSearchResponse FollowupSearch(java.lang.Object queryArray)
queryArray
- Array, declared as Object[], where each element is an IPTSearchQuery (these exact types are required by the .NET wrappers).
IPTSearchQuery CreateBasicQuery(java.lang.String searchString, java.lang.String fields)
searchString
- String to search for (non-null, non-empty)fields
- Fields to search. Usually null, in which
case a default set of fields is searched. Alternatively,
may be a string of the form "PTj[x],PTk[y]", where j and k
are integer property IDs to be searched, and x and y are
corresponding floating-point weights.
IPTSearchQuery CreateAdvancedQuery(IPTFilter filter)
filter
- Filter on which to base the query (non-null and must contain a search string or at least one IPTPropertyFilterStatement)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |