com.ibm.mm.sdk.common

Class DKResults

java.lang.Object

com.ibm.mm.sdk.common.DKSequentialCollection

com.ibm.mm.sdk.common.dkQueryableCollection

com.ibm.mm.sdk.common.DKResults

All Implemented Interfaces:

dkCollection, dkQueryEvaluator, java.io.Serializable

public class DKResults
extends dkQueryableCollection
implements java.io.Serializable

DKResults - Represents a collection of query results from CM8 datastore operations.

See Also:

DKDDO, dkDatastore, Serialized Form

Field Summary

Fields inherited from class com.ibm.mm.sdk.common.DKSequentialCollection

associatedAttrName, currentPosition, fileNetCollection, items, name, owner

Constructor Summary

Constructors

Constructor and Description
DKResults(dkDatastore ds) Constructs a DKResults with a given datastore object.

Method Summary

Modifier and Type	Method and Description
void	addElement(java.lang.Object element) Adds an element to the collection.
void	addItem(DKDDO ddo) Adds a DKDDO object to the results collection.
java.lang.Object	evaluate(java.lang.String query, short qlType, DKNVPair[] params) Evaluates a query against the datastore.

Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection

addAllElements, cardinality, createIterator, getAssociatedAttrName, getFileNetCollection, getName, getOwner, insertElementAt, nextElement, removeAllElements, removeElementAt, replaceElementAt, reset, retrieveElementAt, setAssociatedAttrName, setFileNetCollection, setName, setOwner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DKResults

public DKResults(dkDatastore ds)

Constructs a DKResults with a given datastore object.

Parameters:

ds - the datastore object

Method Detail

evaluate

public java.lang.Object evaluate(java.lang.String query,
                                 short qlType,
                                 DKNVPair[] params)
                          throws DKException,
                                 java.lang.Exception

Evaluates a query against the datastore.

Specified by:

evaluate in interface dkQueryEvaluator

Parameters:

query - the query string

qlType - the query language type

params - query parameters

Returns:

the query results

Throws:

DKException - if a datastore error occurs

java.lang.Exception - if any other error occurs

addItem

public void addItem(DKDDO ddo)

Adds a DKDDO object to the results collection. Public method for use by datastore implementations.

Parameters:

ddo - the DKDDO object to add

addElement

public void addElement(java.lang.Object element)
                throws DKUsageError

Description copied from interface: dkCollection

Adds an element to the collection.

Specified by:

addElement in interface dkCollection

Overrides:

addElement in class DKSequentialCollection

Parameters:

element - the element to add to the collection

Throws:

DKUsageError - if the element is null or cannot be added