|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.server.dkAbstractResultSetCursor | +--com.ibm.mm.sdk.server.DKResultSetCursorDD
This class is a cursor on a result set (a DKResults). Domino.Doc does not stage the results of a query, so the entire result is returned at once.
Also, Domino.Doc, at this point (V2.1), does not support a query on a document collection, so this class does not support execution of a query on a result set.
DKResults
,
DKDatastoreDD.execute(java.lang.String, short, com.ibm.mm.sdk.common.DKNVPair[])
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 |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDD |
copyright, DK_DD_MSG_MSGID_DOMDOC, DK_DD_MSG_MSGID_GOVERNOR, DK_DD_MSG_MSGID_NO_ATTR_OBJ, DK_DD_MSG_MSGID_NO_BINDER_OBJ, DK_DD_MSG_MSGID_NO_CABINET_OBJ, DK_DD_MSG_MSGID_NO_DOCUMENT_OBJ, DK_DD_MSG_MSGID_NO_MESSAGE, DK_DD_MSG_MSGID_NO_ROOM_OBJ, DK_DD_MSG_MSGID_NO_SUCCESS, DK_DD_MSG_MSGID_NUL_PARAM |
Method Summary | |
void |
addObject(DKDDO newDDO)
Adds a new element of the same type, represented by the given DDO, to the datastore. |
int |
cardinality()
Gets the number of query results if supported. |
void |
close()
Closes the cursor, and invalidates the result set. |
java.lang.String |
datastoreName()
Gets the datastore name |
java.lang.String |
datastoreType()
Gets the datastore type |
void |
deleteObject()
Deletes a DDO object at current position from result set from server. |
void |
destroy()
Destroys the resultSetCursor. |
DKDDO |
fetchNext()
Retrieves the next object in the result set |
java.lang.Object |
fetchNextByName(java.lang.String dataItemName)
Get a data item contained within the DDO at the next position in the result. |
boolean |
fetchNextN(int how_many,
dkCollection collection)
Retrieves the next N objects in the result set |
boolean |
fetchNextNByName(java.lang.String dataItemName,
int how_many,
java.lang.Object[] array)
For the next |
DKDDO |
fetchObject()
Retrieves an object at the current postion in the result set Does not change cursor position. |
DKDDO |
findObject(int position,
java.lang.String predicate)
Retrieves a DDO object from result set at given start location |
int |
getPosition()
Gets the current position of the cursor within the result list |
boolean |
isBegin()
Checks to see if the cursor at the beginning of the search result set cursor. |
boolean |
isEnd()
Checks if the cursor is currently at the end of result |
boolean |
isInBetween()
Checks if the cursor at the middle of result list |
boolean |
isOpen()
Checks if the cursor is opened. |
boolean |
isScrollable()
Checks if the search result is scrollable |
boolean |
isValid()
Checks to see if the content of this search result set cursor is valid. |
DKDDO |
newObject()
Creates a new DDO object. |
void |
open()
Opens the cursor, and if necessary, execute the query to get the result set. |
void |
open(DKNVPair[] parms)
Opens the cursor, and if necessary, execute the query to get the result set. |
void |
setPosition(int position,
java.lang.Object value)
Sets the value of cursor to the given position value |
void |
setToNext()
Sets the cursor to the next position |
java.lang.String |
toString()
Returns a string suitable for debugging purposes. |
void |
updateObject(DKDDO ddo)
Updates element at the current position in the datastore, using the given DDO. |
Methods inherited from class com.ibm.mm.sdk.server.dkAbstractResultSetCursor |
fetchObjectByName, handle, handle, isUpdatable, objectType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public boolean isScrollable() throws DKException, java.lang.Exception
isScrollable
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic boolean isValid() throws DKException, java.lang.Exception
isValid
in class dkAbstractResultSetCursor
public boolean isBegin() throws DKException, java.lang.Exception
isBegin
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic boolean isEnd() throws DKException, java.lang.Exception
isEnd
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic boolean isInBetween() throws DKException, java.lang.Exception
isInBetween
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic int getPosition() throws DKException, java.lang.Exception
getPosition
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic void setPosition(int position, java.lang.Object value) throws DKException, java.lang.Exception
setPosition
in class dkAbstractResultSetCursor
position
- either DK_CM_NEXT or DK_CM_RELATIVE.value
- Integer object represents the relative position from
current cursor position.DKDatastoreError
- if there is no connection to server.DKUsageError
- if cursor is invalid, new position is invalid,
or "value" is not Integer objectpublic void setToNext() throws DKException, java.lang.Exception
setToNext
in class dkAbstractResultSetCursor
DKUsageError
- if current cursor position is invalid or the next
cursor position is invalidpublic DKDDO fetchObject() throws DKException, java.lang.Exception
fetchObject
in class dkAbstractResultSetCursor
DKUsageError
- if the result set cursor is invalidpublic DKDDO fetchNext() throws DKException, java.lang.Exception
fetchNext
in class dkAbstractResultSetCursor
DKUsageError
- if the result set cursor is invalidpublic boolean fetchNextN(int how_many, dkCollection collection) throws DKException, java.lang.Exception
fetchNextN
in class dkAbstractResultSetCursor
how_many
- number of next objects to retrievecollection
- a container to receive these N objectsDKUsageError
- if the result set cursor is invalidpublic java.lang.Object fetchNextByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
The cursor is moved to the next object in the result and the data item is retrieved.
fetchNextByName
in class dkAbstractResultSetCursor
dataItemName
- data item nameDKException
- Trying to go past the end of the result
will cause an excpetion to be thrown, or trying
to call this method when the result is not valid
will cause an exception to be thrown.public boolean fetchNextNByName(java.lang.String dataItemName, int how_many, java.lang.Object[] array) throws DKException, java.lang.Exception
fetchNextNByName
in class dkAbstractResultSetCursor
dataItemName
- data item namehow_many
- how many data item values the user wants to be
returned in the collection.array
- the array where the data item values that are fetched
are stored.public DKDDO findObject(int position, java.lang.String predicate) throws DKException, java.lang.Exception
findObject
in class dkAbstractResultSetCursor
position
- start location where to retrieve the DDO object frompredicate
- search conditionDKDatastoreError
- if there is no connection to serverDKUsageError
- if the result is not valid, "predicate" condition
or postion is not valid.public void deleteObject() throws DKException
deleteObject
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to serverDKUsageError
- if one of the following conditions occurred:
public void updateObject(DKDDO ddo) throws DKException
updateObject
in class dkAbstractResultSetCursor
ddo
- a new data object to use to update the current cursor
object from server.DKDatastoreError
- if there is no connection to server.DKUsageError
- if cursor is invalid, or is not updatable, or
the given "ddo" is null.public DKDDO newObject() throws DKException
newObject
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to
server.public void addObject(DKDDO newDDO) throws DKException
addObject
in class dkAbstractResultSetCursor
newDDO
- a new data object to add to server.DKDatastoreError
- if there is no connection to server.DKUsageError
- if cursor is invalid, or is not updatable, or
the given "newDDO" is null.public boolean isOpen() throws DKException, java.lang.Exception
isOpen
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to serverpublic void open() throws DKException, java.lang.Exception
open
in class dkAbstractResultSetCursor
DKUsageError
- if the cursor is already opened or the query
string is invalid.DKDatastoreError
- if there is no connection to the serverDKDatastoreAccessError
- if error occurs inside datastorepublic void open(DKNVPair[] parms) throws DKException, java.lang.Exception
open
in class dkAbstractResultSetCursor
parms
- name/value pairs optionsDKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic java.lang.String datastoreName() throws DKException, java.lang.Exception
dkResultSetCursor
datastoreName
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public java.lang.String datastoreType() throws DKException, java.lang.Exception
dkResultSetCursor
datastoreType
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public int cardinality() throws java.lang.Exception
dkResultSetCursor
Note:DKUsageError exception thrown if method is not implemented
cardinality
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public void close() throws DKException
close
in class dkAbstractResultSetCursor
public void destroy() throws DKException
destroy
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to serverpublic java.lang.String toString()
toString
in class java.lang.Object
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |