com.webmethods.common.search.query

Interface ISearchQuery

public interface ISearchQuery

Wrapper around a search query

Method Summary

Modifier and Type	Method and Description
IQueryFilter[]	getFilterQueries() Return all the filter queries
int	getInvocationID() Return the unique id for the search invocation that created this search query
String	getKeywordQuery() Return the query string for the keywords field
int	getMaxResults() Return the maximum number of search results that should be returned
IQueryRefine[]	getRefineQueries() Return all the refine queries
boolean	useOrCondition() Return true to use an 'or' query

Method Detail

getInvocationID

int getInvocationID()

Return the unique id for the search invocation that created this search query

Returns:

id of the search invocation

getKeywordQuery

String getKeywordQuery()

Return the query string for the keywords field

Returns:

keyword query string

getRefineQueries

IQueryRefine[] getRefineQueries()

Return all the refine queries

Returns:

array of refine queries

getFilterQueries

IQueryFilter[] getFilterQueries()

Return all the filter queries

Returns:

array of filter queries

getMaxResults

int getMaxResults()

Return the maximum number of search results that should be returned

Returns:

max number of search results

useOrCondition

boolean useOrCondition()

Return true to use an 'or' query

Returns:

true for 'or' query false otherwise