|
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.DKResultSetCursorIC
This is the result set cursor for IC datastores. It is returned by the execute methods of the DKDatastoreIC class.
DKDatastoreIC
,
DKDatastoreIC.execute( String, short, DKNVPair[] )
,
DKDatastoreIC.execute( dkQuery )
,
DKDatastoreIC.execute( DKCQExpr )
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIC |
DK_CM_PARM_LINKS, DK_IC_DSTYPE |
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.DKMessageIdIC |
DK_IC_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKResultSetCursorIC(DKDatastoreIC ds,
java.lang.String entityName,
dkResultSetCursor rs,
DKNVPair[] params)
|
|
DKResultSetCursorIC(DKDatastoreIC ds,
java.lang.String entityName,
dkResultSetCursor rs,
DKQExpr qe,
DKNVPair[] params)
|
Method Summary | |
void |
addObject(DKDDO ddo)
Add an object to the cursor data set. |
int |
cardinality()
Return the number of rows in the result set |
void |
close()
Closes the cursor and invalidates the result set. |
java.lang.String |
datastoreName()
Returns the name of the datastore that this cursor is operating against. |
java.lang.String |
datastoreType()
Returns the type of the datastore that this cursor is operating against. |
void |
deleteObject()
Delete an object from the cursor data set. |
void |
destroy()
Closes and removes the cursor, allowing for cleanup before garbage collection. |
DKDDO |
fetchNext()
Advances the cursor to the next position and returns the DKDDO that it points to. |
boolean |
fetchNextN(int howMany,
dkCollection collection)
Fetches the specified number of DKDDO objects and returns them in a collection. |
DKDDO |
fetchObject()
Returns the DKDDO object at the current cursor position. |
DKDDO |
findObject(int position,
java.lang.String predicate)
Returns the first DKDDO object that matches the search condition. |
int |
getPosition()
Returns the position of the cursor as an integer. |
DKHandle |
handle(java.lang.String type)
Returns the result set handle that is associated with the result set cursor, by type. |
boolean |
isBegin()
Returns whether or not the cursor is at the beginning of the dataset. |
boolean |
isEnd()
Returns whether or not the cursor is at the ending of the dataset. |
boolean |
isInBetween()
Returns whether or not the cursor is neither at the beginning or the ending of the dataset. |
boolean |
isOpen()
Indicates whether or not this cursor is open. |
boolean |
isScrollable()
Returns whether or not this cursor is scrollable. |
boolean |
isUpdatable()
Returns whether or not this cursor is updatable. |
boolean |
isValid()
Returns whether or not the cursor is in a valid state. |
DKDDO |
newObject()
Creates an empty DKDDO of the object type referenced by this cursor. |
void |
open()
Opens the cursor and, if necessary, executes the query to get the result set |
void |
setPosition(int position,
java.lang.Object value)
Sets the position of the cursor to the location specified. |
void |
setToNext()
Sets the cursor to the next position. |
void |
updateObject(DKDDO ddo)
Update an object in the cursor data set. |
Methods inherited from class com.ibm.mm.sdk.server.dkAbstractResultSetCursor |
fetchNextByName, fetchNextNByName, fetchObjectByName, handle, objectType, open |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKResultSetCursorIC(DKDatastoreIC ds, java.lang.String entityName, dkResultSetCursor rs, DKNVPair[] params) throws DKException, java.lang.Exception
public DKResultSetCursorIC(DKDatastoreIC ds, java.lang.String entityName, dkResultSetCursor rs, DKQExpr qe, DKNVPair[] params) throws DKException, java.lang.Exception
Method Detail |
public boolean isScrollable() throws DKException, java.lang.Exception
isScrollable
in class dkAbstractResultSetCursor
public boolean isUpdatable() throws DKException, java.lang.Exception
isUpdatable
in class dkAbstractResultSetCursor
public boolean isValid() throws DKException, java.lang.Exception
isValid
in class dkAbstractResultSetCursor
public boolean isBegin() throws DKException, java.lang.Exception
isBegin
in class dkAbstractResultSetCursor
public boolean isEnd() throws DKException, java.lang.Exception
isEnd
in class dkAbstractResultSetCursor
public boolean isInBetween() throws DKException, java.lang.Exception
isInBetween
in class dkAbstractResultSetCursor
public int getPosition() throws DKException, java.lang.Exception
getPosition
in class dkAbstractResultSetCursor
public int cardinality() throws DKException, java.lang.Exception
cardinality
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public void setPosition(int position, java.lang.Object value) throws DKException, java.lang.Exception
setPosition
in class dkAbstractResultSetCursor
position
- Type of setPosition operation, either DK_CM_NEXT for
advancing position one place or DK_CM_RELATIVE that
advances the cursor by the amount specified in the
value object.value
- An object, which must be an Integer, that contains
the offset for the setPosition DK_CM_RELATIVE
operation.public void setToNext() throws DKException, java.lang.Exception
setToNext
in class dkAbstractResultSetCursor
public DKDDO fetchObject() throws DKException, java.lang.Exception
fetchObject
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public DKDDO fetchNext() throws DKException, java.lang.Exception
fetchNext
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public boolean fetchNextN(int howMany, dkCollection collection) throws DKException, java.lang.Exception
fetchNextN
in class dkAbstractResultSetCursor
howMany
- The number of objects to return. 0 is all.collection
- The collection to return the objects in.public DKDDO findObject(int position, java.lang.String predicate) throws DKException, java.lang.Exception
findObject
in class dkAbstractResultSetCursor
position
- Type of findObject operation, only DK_CM_NEXT is
supported. Indicates a search starting from the
next position and advancing until the end.predicate
- The search condition of the form
public void addObject(DKDDO ddo) throws DKException, java.lang.Exception
addObject
in class dkAbstractResultSetCursor
DKUsageError
- if this method is called.public void deleteObject() throws DKException, java.lang.Exception
deleteObject
in class dkAbstractResultSetCursor
DKUsageError
- if this method is called.public void updateObject(DKDDO ddo) throws DKException, java.lang.Exception
updateObject
in class dkAbstractResultSetCursor
DKUsageError
- if this method is called.public DKDDO newObject() throws DKException, java.lang.Exception
newObject
in class dkAbstractResultSetCursor
public void open() throws DKException, java.lang.Exception
open
in class dkAbstractResultSetCursor
public void close() throws DKException, java.lang.Exception
close
in class dkAbstractResultSetCursor
public boolean isOpen() throws DKException, java.lang.Exception
isOpen
in class dkAbstractResultSetCursor
public void destroy() throws DKException, java.lang.Exception
destroy
in class dkAbstractResultSetCursor
public java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in class dkAbstractResultSetCursor
public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in class dkAbstractResultSetCursor
public DKHandle handle(java.lang.String type) throws java.lang.Exception
handle
in class dkAbstractResultSetCursor
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |