com.ibm.pim.interfaces.search
Interface SearchResultSet


public interface SearchResultSet

Read-only interface for Query results, contains a set of SearchResultRow


Field Summary
static java.lang.String copyright
          IBM standard copyright
 
Method Summary
 Item getItem(int columnIndex)
          Get the value of a column in the current row as Java Float value.It can be used for Itemobject
 SearchColumnType[] getMetaData()
          Returns MetaData information of each column of resultset in form of com.ibm.pim.interfaces.search.SqlColumnTypearray.
 SearchQuery getQuery()
          Returns the Query object which returned this SearchResultSet.
 boolean next()
          Use this method to iterate through rows in result set.
 int size()
          Returns the number of rows in the resultset.
 

Field Detail

copyright

public static final java.lang.String copyright
IBM standard copyright
Method Detail

getQuery

public SearchQuery getQuery()
                     throws PIMInternalException,
                            PIMAuthorizationException
Returns the Query object which returned this SearchResultSet.
Returns:
Returns Query object to which this result set applies
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getMetaData

public SearchColumnType[] getMetaData()
                               throws PIMInternalException,
                                      PIMAuthorizationException
Returns MetaData information of each column of resultset in form of com.ibm.pim.interfaces.search.SqlColumnTypearray.
Returns:
Returns SqlColumnType array
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

next

public boolean next()
             throws PIMInternalException,
                    PIMAuthorizationException
Use this method to iterate through rows in result set. It returns false when there are no more rows available in resultset
Returns:
Returns true if more rows are available in the resultset
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

size

public int size()
         throws PIMInternalException,
                PIMAuthorizationException
Returns the number of rows in the resultset.
Returns:
Number of rows in resultset.
Throws:
PIMInternalException -  
PIMAuthorizationException -  

getItem

public Item getItem(int columnIndex)
             throws PIMSearchException,
                    PIMInternalException,
                    PIMAuthorizationException
Get the value of a column in the current row as Java Float value.It can be used for Itemobject
Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value. If there is no value(null value) for this column then it will return null.
Throws:
PIMSearchException - if a search error occurs
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation