com.ibm.pim.interfaces.search
Interface SearchResultSet


Deprecated.

public interface SearchResultSet

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


Field Summary
static java.lang.String copyright
          Deprecated.  
 
Method Summary
 boolean getBoolean(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for "Flag" SpecNode type.
 Catalog getCatalog(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for Catalogobject
 Category getCategory(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for Categoryobject.
 java.util.Date getDate(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for "Date" SpecNode type.
 double getDouble(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java double value.It can be used for "Number" SpecNode type.
 float getFloat(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for "Number" SpecNode type.
 Hierarchy getHierarchy(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for Hierarchyobject
 int getInt(int columnIndex)
          Deprecated. Get the value of a column in the current row as a Java int value.
 Item getItem(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for Itemobject
 long getLong(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java long value.It can be used for "Number" SpecNode type.
 SearchColumnType[] getMetaData()
          Deprecated. Returns MetaData information of each column of resultset in form of SearchColumnTypearray.
 SearchQuery getQuery()
          Deprecated. Returns the Query object which returned this SearchResultSet.
 Spec getSpec(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java Float value.It can be used for Specobject
 java.lang.String getString(int columnIndex)
          Deprecated. Get the value of a column in the current row as Java String value.It can be used for all kind of specnode type e.g "Binary,Grouping,Image,Image url,Lookup table,Password,String,String enumeration,Thumbnail image,Thumbnail image url,Timezone,URL" etc.
 boolean next()
          Deprecated. Use this method to iterate through rows in result set.
 int size()
          Deprecated. Returns the number of rows in the resultset.
 

Field Detail

copyright

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

getQuery

SearchQuery getQuery()
                     throws PIMInternalException,
                            PIMAuthorizationException
Deprecated. 
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

SearchColumnType[] getMetaData()
                               throws PIMInternalException,
                                      PIMAuthorizationException
Deprecated. 
Returns MetaData information of each column of resultset in form of SearchColumnTypearray.

Returns:
Returns SqlColumnType array
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

next

boolean next()
             throws PIMInternalException,
                    PIMAuthorizationException
Deprecated. 
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

int size()
         throws PIMInternalException,
                PIMAuthorizationException
Deprecated. 
Returns the number of rows in the resultset.

Returns:
Number of rows in resultset.
Throws:
PIMInternalException
PIMAuthorizationException

getInt

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

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

getDouble

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

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

getFloat

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

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

getLong

long getLong(int columnIndex)
             throws PIMSearchException,
                    PIMInternalException,
                    PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java long value.It can be used for "Number" SpecNode 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:
PIMSearchException
PIMInternalException
PIMAuthorizationException

getString

java.lang.String getString(int columnIndex)
                           throws PIMSearchException,
                                  PIMInternalException,
                                  PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java String value.It can be used for all kind of specnode 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:
PIMUndefinedValueException - if the column has no value (null)
PIMSearchException - if a search error occurs
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getBoolean

boolean getBoolean(int columnIndex)
                   throws PIMSearchException,
                          PIMInternalException,
                          PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java Float value.It can be used for "Flag" SpecNode type.

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

getDate

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

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

getItem

Item getItem(int columnIndex)
             throws PIMSearchException,
                    PIMInternalException,
                    PIMAuthorizationException
Deprecated. 
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

getCategory

Category getCategory(int columnIndex)
                     throws PIMSearchException,
                            PIMInternalException,
                            PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java Float value.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:
PIMSearchException - if a search error occurs
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getCatalog

Catalog getCatalog(int columnIndex)
                   throws PIMSearchException,
                          PIMInternalException,
                          PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java Float value.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. v
Throws:
PIMSearchException
PIMInternalException
PIMAuthorizationException

getHierarchy

Hierarchy getHierarchy(int columnIndex)
                       throws PIMSearchException,
                              PIMInternalException,
                              PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java Float value.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:
PIMSearchException - if a search error occurs
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getSpec

Spec getSpec(int columnIndex)
             throws PIMSearchException,
                    PIMInternalException,
                    PIMAuthorizationException
Deprecated. 
Get the value of a column in the current row as Java Float value.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:
PIMSearchException - if a search error occurs
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation