|
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.DKResultSetCursorV4
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantV4 |
For details, see the class or interface |
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.DKMessageIdV4 |
copyright, DK_V4_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Method Summary | |
void |
addObject(DKDDO ddo)
Adds a new element of the same type, represented by the given DDO, to the datastore. |
int |
cardinality()
Gets the number of elements in the resultset |
void |
close()
Closes the cursor and invalidates the result set. |
java.lang.String |
datastoreName()
Gets the name of the datastore associated with the datastore definition to which the resultset cursor belongs |
java.lang.String |
datastoreType()
Gets the type of the datastore associated with the datastore definition to which the resultset cursor belongs |
void |
deleteObject()
Deletes the element at the current position from the datastore |
void |
destroy()
Destroys the cursor. |
DKDDO |
fetchNext()
Fetches the next element of the result set and returns it as a DDO. |
java.lang.Object |
fetchNextByName(java.lang.String dataItemName)
Sets cursor to point to the position of the next data object and fetches the data item value in the cursor at that position by data item name. |
boolean |
fetchNextN(int how_many,
dkCollection collection)
Fetches the next N elements of the result set and inserts them in the given collection. |
boolean |
fetchNextNByName(java.lang.String dataItemName,
int how_many,
java.lang.Object[] array)
Fetches the next N data item values of the cursor and inserts them into the given array |
DKDDO |
fetchObject()
Fetches the element of the result set at the current position and returns it as a DDO. |
java.lang.Object |
fetchObjectByName(java.lang.String dataItemName)
Fetches the data item value in the cursor at the current position by data item name |
DKDDO |
findObject(int position,
java.lang.String predicate)
Finds the data object which satisfies the given predicate, move the cursor to that position, fetch and return the data object. |
int |
getPosition()
Gets the current position of the cursor |
DKHandle |
handle(int type)
Gets the resultset handle that is associated with the resultset cursor by type. |
DKHandle |
handle(java.lang.String type)
Gets a cursor handle |
boolean |
isBegin()
Checks if the cursor is positioned at the beginning |
boolean |
isEnd()
Checks if the cursor is positioned at the end |
boolean |
isInBetween()
Checks if the cursor is positioned in between data objects in the result set |
boolean |
isOpen()
Checks if the cursor is in the open state |
boolean |
isScrollable()
Checks if the cursor can be scrolled forward and backward |
boolean |
isUpdatable()
Checks if the cursor is updateable |
boolean |
isValid()
Checks if the cursor is valid |
DKDDO |
newObject()
Creates a new element of the same type |
java.lang.String |
objectType()
Gets the cursor object type |
void |
open()
Opens the cursor, and if necessary, execute the query to get the the result set. |
void |
open(DKNVPair[] parms)
Opens the cursor, and if necessary, execute the query to get the the result set. |
void |
setPosition(int position,
java.lang.Object value)
Sets the cursor to the given position |
void |
setToNext()
Sets the cursor to point to the position of the next data object in the result set. |
void |
updateObject(DKDDO ddo)
Updates the element at the current position in the datastore, using the given DDO. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public boolean isScrollable() throws DKException, java.lang.Exception
isScrollable
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean isUpdatable() throws DKException, java.lang.Exception
isUpdatable
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean isValid() throws DKException, java.lang.Exception
isValid
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean isOpen() throws DKException, java.lang.Exception
isOpen
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean isBegin() throws DKException, java.lang.Exception
isBegin
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean isEnd() throws DKException, java.lang.Exception
isEnd
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean isInBetween() throws DKException, java.lang.Exception
isInBetween
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic int getPosition() throws DKException, java.lang.Exception
getPosition
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void setPosition(int position, java.lang.Object value) throws DKException, java.lang.Exception
setPosition
in class dkAbstractResultSetCursor
position
- the value for the position
The valid positions are:
value
- a Long object
If the position is specified as DK_CM_ABSOLUTE or DK_CM_RELATIVE, the value parameter specifies the absolute or relative position value. For non-scrollable cursor, the valid positions are only DK_CM_NEXT and DK_CM_RELATIVE.
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void setToNext() throws DKException, java.lang.Exception
setToNext
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic DKDDO fetchObject() throws DKException, java.lang.Exception
fetchObject
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic DKDDO fetchNext() throws DKException, java.lang.Exception
fetchNext
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic boolean fetchNextN(int how_many, dkCollection collection) throws DKException, java.lang.Exception
fetchNextN
in class dkAbstractResultSetCursor
how_many
- the number of elements to fetchcollection
- the dkCollection object to hold the retrieved elementsDKException
- if error defectedjava.lang.Exception
- if error dedectedpublic java.lang.Object fetchObjectByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
dkResultSetCursor
fetchObjectByName
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
dataItemName
- data item namepublic java.lang.Object fetchNextByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
dkResultSetCursor
fetchNextByName
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
dataItemName
- data item namepublic boolean fetchNextNByName(java.lang.String dataItemName, int how_many, java.lang.Object[] array) throws DKException, java.lang.Exception
dkResultSetCursor
fetchNextNByName
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
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
- The valid positions for the scrollable cursor are
DK_CM_FIRST, DK_CM_LAST, DK_CM_NEXT, and DK_CM_PREVIOUS. These positions are
described in setPosition().
predicate
- The prdicate string. The format of the predicate string
is AttributeName RelOp Value, where RelOp are relational operators, such
as =, ==, <=, >=, <, >, or <>.DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void deleteObject() throws DKException, java.lang.Exception
deleteObject
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void updateObject(DKDDO ddo) throws DKException, java.lang.Exception
updateObject
in class dkAbstractResultSetCursor
ddo
- the given DDO object used to update the elementDKException
- if error defectedjava.lang.Exception
- if error dedectedpublic DKDDO newObject() throws DKException, java.lang.Exception
newObject
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void addObject(DKDDO ddo) throws DKException, java.lang.Exception
addObject
in class dkAbstractResultSetCursor
ddo
- the given DDO object used to add the new elementDKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void open() throws DKException, java.lang.Exception
open
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void close() throws DKException, java.lang.Exception
close
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void destroy() throws DKException, java.lang.Exception
destroy
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic void open(DKNVPair[] parms) throws DKException, java.lang.Exception
open
in class dkAbstractResultSetCursor
parms
- the array of DKNVPair (name-value pair) objects that's used
to check for combined queryDKException
- if error defectedjava.lang.Exception
- if error dedectedpublic java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic DKHandle handle(int type) throws java.lang.Exception
handle
in class dkAbstractResultSetCursor
DKException
- if error defectedjava.lang.Exception
- if error dedectedpublic DKHandle handle(java.lang.String type) throws java.lang.Exception
dkResultSetCursor
handle
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
type
- type of cursor handle wantedpublic int cardinality() throws java.lang.Exception
cardinality
in class dkAbstractResultSetCursor
java.lang.Exception
- if error dedectedpublic java.lang.String objectType() throws java.lang.Exception
dkResultSetCursor
objectType
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |