|
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.DKResultSetCursorIP
This class is a datastore cursor which manages a virtual collection of objects. The collection is a result set of a query submitted to the datastore.
dkResultSetCursor
, Serialized FormField Summary | |
java.lang.String |
_storeSite
|
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIP |
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.DKMessageId |
For details, see the class or interface |
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 |
cursorName()
Get the cursor name |
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. |
void |
destroyByDS()
This method will be called from datastore before it go away. |
DKDDO |
fetchNext()
Retrieves the next object in the result set |
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)
Retrieves the next N objects in the result set |
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()
Retrieves an object at the current postion in the result set |
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)
Retrieves a DDO object from result set at given start location |
int |
getPosition()
Gets the current position of the cursor within the result list |
DKHandle |
handle(int type)
Deprecated. Replace by handle(String type) |
DKHandle |
handle(java.lang.String type)
Gets a cursor handle |
boolean |
isBegin()
Checks to see if the cursor at the beginning of the search result set cursor. |
boolean |
isConnected()
Checks to see if there is connection to server |
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 |
isUpdatable()
Checks if the search result set cursor is updatable |
boolean |
isValid()
Checks to see if the content of this search result set cursor is valid. |
DKDDO |
newObject()
Creates a new DDO object. |
java.lang.String |
objectType()
Gets the cursor object type |
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 |
void |
updateObject(DKDDO ddo)
Updates 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 |
Field Detail |
public java.lang.String _storeSite
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 isUpdatable() throws DKException, java.lang.Exception
isUpdatable
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 isOpen() throws DKException, java.lang.Exception
isOpen
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to serverpublic 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
DKDatastoreError
- if there is no connection to server.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
DKDatastoreError
- if there is no connection to server.DKUsageError
- if the result set cursor is invalidpublic DKDDO fetchNext() throws DKException, java.lang.Exception
fetchNext
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to server.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 retrieve. If 0, then all remaining
objects will be retrieved.collection
- a container to receive these N objectsDKDatastoreError
- if there is no connection to Server.DKUsageError
- if the result set cursor is invalidpublic java.lang.Object fetchObjectByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
fetchObjectByName
in class dkAbstractResultSetCursor
dataItemName
- data item namepublic java.lang.Object fetchNextByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
fetchNextByName
in class dkAbstractResultSetCursor
dataItemName
- data item namepublic 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 fromposition
- only DK_CM_NEXT is supported.predicate
- 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, java.lang.Exception
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, java.lang.Exception
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, java.lang.Exception
newObject
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to
server.public void addObject(DKDDO newDDO) throws DKException, java.lang.Exception
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 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 close() throws DKException, java.lang.Exception
close
in class dkAbstractResultSetCursor
DKUsageError
- if the cursor is not openned.DKDatastoreError
- if there is no connection to serverpublic void destroy() throws DKException, java.lang.Exception
destroy
in class dkAbstractResultSetCursor
DKDatastoreError
- if there is no connection to serverpublic void destroyByDS() throws DKException, java.lang.Exception
DKException
- public 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 boolean isConnected() throws java.lang.Exception
public java.lang.String cursorName() throws java.lang.Exception
public 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 DKHandle handle(int type) throws java.lang.Exception
handle
in class dkAbstractResultSetCursor
type
- type of cursor handle wantedhandle(java.lang.String)
public DKHandle handle(java.lang.String type) throws java.lang.Exception
handle
in class dkAbstractResultSetCursor
type
- type of cursor handle wantedpublic int cardinality() throws DKException, java.lang.Exception
dkResultSetCursor
Note:DKUsageError exception thrown if method is not implemented
cardinality
in class dkAbstractResultSetCursor
com.ibm.mm.sdk.common.dkResultSetCursor
public 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 |