com.ibm.pim.interfaces.search
Interface SearchQuery
- public interface SearchQuery
Read-only, but executable interface for query object.
Field Summary |
static java.lang.String |
copyright
IBM standard copyright |
copyright
public static final java.lang.String copyright
- IBM standard
copyright
execute
public SearchResultSet execute()
throws PIMInternalException,
PIMAuthorizationException
- Executes the Query and returns the SearchResultSet
- Returns:
- queryResultSet the query result set
- Throws:
PIMInternalException
- If an internal error occursPIMAuthorizationException
- If the user is not allowed to perform this operation
getMetaData
public SearchColumnType[] getMetaData()
throws PIMInternalException,
PIMAuthorizationException
- Returns meta data about the result set
- Returns:
- SqlColumnType object containing metadata about the result set
- Throws:
PIMInternalException
- If an internal error occursPIMAuthorizationException
- If the user is not allowed to perform this operation
isItemQuery
public boolean isItemQuery()
throws PIMInternalException,
PIMAuthorizationException
- 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 occursPIMAuthorizationException
- If the user is not allowed to perform this operation