Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkPersistentQuery

All Superinterfaces:
dkQuery, dkQueryBase

public interface dkPersistentQuery
extends dkQuery

This interface extends the interface of dkQuery to include methods to make a query persistent in the datastore. An example of a concrete implementation of dkPersistentQuery is DKTemplateQuery, which represents a search template that can be made persistent for repeated executions.

Also, for the add, delete, update, and retrieve operations, the datastore need to be set and it must have a valid connection.



Method Summary
 void add()
          Adds this query to the datastore, i.e.
 void del()
          Deletes this query from the datastore.
 java.lang.String getName()
          Gets the name of this query
 void retrieve()
          Retrieves this query from the datastore.
 void setName(java.lang.String name)
          Sets the name of this query
 void update()
          Updates this query in the datastore.
 
Methods inherited from interface com.ibm.mm.sdk.common.dkQuery
datastore, getDatastore, qlType, queryString, setDatastore
 
Methods inherited from interface com.ibm.mm.sdk.common.dkQueryBase
execute, numberOfResults, prepare, result, resultSetCursor, status
 

Method Detail

getName

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

setName

public void setName(java.lang.String name)
Sets the name of this query
Specified by:
setName in interface dkQuery
Parameters:
name - name of this query

add

public void add()
         throws DKException
Adds this query to the datastore, i.e. make this query persistent.

del

public void del()
         throws DKException
Deletes this query from the datastore. The in-memory copy is not affected.

update

public void update()
            throws DKException
Updates this query in the datastore.

retrieve

public void retrieve()
              throws DKException
Retrieves this query from the datastore. You need to set the query name before calling this method.

EIP Java APIs

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