Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKTextQuery

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKTextQuery
All Implemented Interfaces:
DKConstant, DKMessageId, dkQuery, dkQueryBase, java.io.Serializable

public class DKTextQuery
extends java.lang.Object
implements dkQuery, DKConstant, DKMessageId, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKTextQuery(dkDatastore creator, DKCQExpr queryExpr)
          Constructs a text query
DKTextQuery(dkDatastore creator, java.lang.String queryString)
          Constructs a text query
DKTextQuery(DKTextQuery fromQuery)
          Constructs a text query from a text query object
 
Method Summary
 dkDatastore datastore()
          Deprecated. Replace by getDatastore
 void execute(DKNVPair[] params)
          execute the query.
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getName()
          Gets query name
 int numberOfResults()
          Gets the number of query results
 void prepare(DKNVPair[] params)
          prepare the query.
 short qlType()
          get query type.
 java.lang.String queryString()
          get query string
 java.lang.Object result()
          get query result.
 dkResultSetCursor resultSetCursor()
          get query result.
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setName(java.lang.String name)
          Sets query name
 int status()
          get query status.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKTextQuery

public DKTextQuery(dkDatastore creator,
                   java.lang.String queryString)
Constructs a text query
Parameters:
creator - datastore
queryString - a query string

DKTextQuery

public DKTextQuery(dkDatastore creator,
                   DKCQExpr queryExpr)
Constructs a text query
Parameters:
creator - datastore
queryExpr - a query expression

DKTextQuery

public DKTextQuery(DKTextQuery fromQuery)
Constructs a text query from a text query object
Parameters:
fromQuery - text query
Method Detail

prepare

public void prepare(DKNVPair[] params)
             throws DKException,
                    java.lang.Exception
prepare the query.
Specified by:
prepare in interface dkQueryBase
Parameters:
params - additional prepare query option in name/value pair

execute

public void execute(DKNVPair[] params)
             throws DKException,
                    java.lang.Exception
execute the query.
Specified by:
execute in interface dkQueryBase
Parameters:
params - additional query option in name/value pair

status

public int status()
get query status.
Specified by:
status in interface dkQueryBase
Returns:
query status

result

public java.lang.Object result()
                        throws DKException,
                               java.lang.Exception
get query result.
Specified by:
result in interface dkQueryBase
Returns:
query result in a DKResults object

resultSetCursor

public dkResultSetCursor resultSetCursor()
                                  throws DKException,
                                         java.lang.Exception
get query result.
Specified by:
resultSetCursor in interface dkQueryBase
Returns:
query result in a dkResultSetCursor object

qlType

public short qlType()
get query type.
Specified by:
qlType in interface dkQuery
Returns:
query type

queryString

public java.lang.String queryString()
get query string
Specified by:
queryString in interface dkQuery
Returns:
query string

datastore

public dkDatastore datastore()
Deprecated. Replace by getDatastore

Gets the reference to the owner datastore object
Specified by:
datastore in interface dkQuery
Returns:
the dkDatastore object
See Also:
getDatastore()

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkQuery
Returns:
the dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException,
                         java.lang.Exception
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkQuery
Parameters:
ds - a datastore

getName

public java.lang.String getName()
Gets query name
Specified by:
getName in interface dkQuery
Returns:
name of this query

setName

public void setName(java.lang.String name)
Sets query name
Specified by:
setName in interface dkQuery
Parameters:
name - new name to be set to this query object

numberOfResults

public int numberOfResults()
Gets the number of query results
Specified by:
numberOfResults in interface dkQueryBase
Returns:
number of query results

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.