com.ibm.pim.search
Interface SearchResultSet


public interface SearchResultSet

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

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 boolean getBoolean(int columnIndex)
          Get the value of a column in the current row as Java Boolean value.
 Catalog getCatalog(int columnIndex)
          Get the value of a column in the current row as MDMPIM Catalog object.
 Category getCategory(int columnIndex)
          Get the value of a column in the current row as MDMPIM Category object.
 java.util.Date getDate(int columnIndex)
          Get the value of a column in the current row as Java Date value.
 double getDouble(int columnIndex)
          Get the value of a column in the current row as Java double value.
 float getFloat(int columnIndex)
          Get the value of a column in the current row as Java Float value.
 Hierarchy getHierarchy(int columnIndex)
          Get the value of a column in the current row as MDMPIM Hierarchy object.
 int getInt(int columnIndex)
          Get the value of a column in the current row as a Java int value.
 Item getItem(int columnIndex)
          Get the value of a column in the current row as MDMPIM Item object.
 long getLong(int columnIndex)
          Get the value of a column in the current row as Java long value.
 SearchQuery getSearchQuery()
          Returns the Query object which returned this SearchResultSet.
 Spec getSpec(int columnIndex)
          Get the value of a column in the current row as MDMPIM Spec object.
 java.lang.String getString(int columnIndex)
          Get the value of a column in the current row as Java String value.
 void moveCursor(int rowIndex)
          Move cursor to the row in the Resultset with index specified in the input parameter.
 boolean next()
          Use this method to iterate through rows in result set.
 void resetCursor()
          Reset cursor to first row of the Resultset.
 int size()
          Returns the number of rows in the resultset.
 

Field Detail

copyright

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

getSearchQuery

SearchQuery getSearchQuery()
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

next

boolean next()
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

size

int size()
Returns the number of rows in the resultset.

Returns:
Number of rows in resultset.
Throws:
PIMInternalException - If an internal error occurs

getInt

int getInt(int columnIndex)
           throws PIMSearchException
Get the value of a column in the current row as a Java int value. It can be used for "Number" AttributeDefinition type

Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value.
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMUndefinedValueException - if the column has no value (null)

getDouble

double getDouble(int columnIndex)
                 throws PIMSearchException
Get the value of a column in the current row as Java double value. It can be used for "Number" AttributeDefinition type.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value.
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMUndefinedValueException - if the column has no value (null)

getFloat

float getFloat(int columnIndex)
               throws PIMSearchException
Get the value of a column in the current row as Java Float value. It can be used for "Number" AttributeDefinition type.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMUndefinedValueException - if the column has no value (null)

getLong

long getLong(int columnIndex)
             throws PIMSearchException
Get the value of a column in the current row as Java long value. It can be used for "Number" AttributeDefinition type.

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 throw PIMUndefinedValueException exception.
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException

getString

java.lang.String getString(int columnIndex)
                           throws PIMSearchException
Get the value of a column in the current row as Java String value. It can be used for all kind of attributedefinition type e.g "Binary,Grouping,Image,Image url,Lookup table,Password,String,String enumeration,Thumbnail image,Thumbnail image url,Timezone,URL" etc.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value.
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMUndefinedValueException - if the column has no value (null)

getBoolean

boolean getBoolean(int columnIndex)
                   throws PIMSearchException
Get the value of a column in the current row as Java Boolean value. It can be used for "Flag" AttributeDefinition type.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value.
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMUndefinedValueException - if the column has no value (null)

getDate

java.util.Date getDate(int columnIndex)
                       throws PIMSearchException
Get the value of a column in the current row as Java Date value. It can be used for "Date" AttributeDefinition type.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
Returns:
the column value.
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMUndefinedValueException - if the column has no value (null)

getItem

Item getItem(int columnIndex)
             throws PIMSearchException
Get the value of a column in the current row as MDMPIM Item object. 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:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.CATALOG_VIEW_ITEMS
PIMSearchException - if a search error occurs

getCategory

Category getCategory(int columnIndex)
                     throws PIMSearchException
Get the value of a column in the current row as MDMPIM Category object. It can be used for Categoryobject.

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:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.HIERARCHY_VIEW_HIERARCHY_NODES
PIMSearchException - if a search error occurs

getCatalog

Catalog getCatalog(int columnIndex)
                   throws PIMSearchException
Get the value of a column in the current row as MDMPIM Catalog object. It can be used for Catalogobject

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:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.CATALOG_LIST
PIMSearchException - if a search error occurs

getHierarchy

Hierarchy getHierarchy(int columnIndex)
                       throws PIMSearchException
Get the value of a column in the current row as MDMPIM Hierarchy object. It can be used for Hierarchyobject

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:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.HIERARCHY_LIST
PIMSearchException - if a search error occurs

getSpec

Spec getSpec(int columnIndex)
             throws PIMSearchException
Get the value of a column in the current row as MDMPIM Spec object. It can be used for Specobject

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:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs
PIMAuthorizationException - Reserved for future use

moveCursor

void moveCursor(int rowIndex)
                throws PIMSearchException
Move cursor to the row in the Resultset with index specified in the input parameter.

Parameters:
rowIndex -
Throws:
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs

resetCursor

void resetCursor()
                 throws PIMSearchException
Reset cursor to first row of the Resultset.

Throws:
PIMSearchException
PIMInternalException - If an internal error occurs
PIMSearchException - if a search error occurs