com.ibm.pim.search
Interface SearchQuery


public interface SearchQuery

Read-only, but executable interface for query object.


Nested Class Summary
static class SearchQuery.ColumnType
           
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 SearchResultSet execute()
          Executes the Query and returns the SearchResultSet
 java.util.List<SearchQuery.ColumnType> getColumnTypes()
          Returns the list of column types associated with the desired result set of the query.
 boolean isItemQuery()
          Returns true if query is on a PIM Item.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

execute

SearchResultSet execute()
Executes the Query and returns the SearchResultSet

Returns:
queryResultSet the query result set
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getColumnTypes

java.util.List<SearchQuery.ColumnType> getColumnTypes()
Returns the list of column types associated with the desired result set of the query.

Returns:
List of ColumnType associated with the query
Throws:
PIMInternalException - If an internal error occurs
java.lang.UnsupportedOperationException - if the return column type does not match any of the internal column types

isItemQuery

boolean isItemQuery()
Returns true if query is on a PIM Item.

Returns:
true if it is an Item query, otherwise false
Throws:
PIMInternalException - If an internal error occurs