|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
dkResultSetCursor is a datastore cursor that manages a collection of DDO objects. The collection contains the results of a query submitted to the datstore. Elements are not added to the collection until a datastore fetch operation is executed.
dkResultSetCursor is an interface that requires a specific implementation for the target datastore. For example:
Method Summary | |
void |
addObject(DKDDO ddo)
Adds an element to the datastore |
int |
cardinality()
Gets the number of query results if supported. |
void |
close()
Close 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 element at the current cursor position from the datastore |
void |
destroy()
Destroys the cursor. |
DKDDO |
fetchNext()
Sets cursor to point to the position of the next data object and fetches the element in the cursor at that position |
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 cursor and inserts them into 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 in the cursor at the current position |
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)
Deprecated. No replacement |
int |
getPosition()
Gets the current cursor position |
DKHandle |
handle(int type)
Deprecated. Replace by handle(String type) |
DKHandle |
handle(java.lang.String type)
Gets a cursor handle |
boolean |
isBegin()
Begin indicator |
boolean |
isEnd()
End indicator |
boolean |
isInBetween()
Between data objects in cursor indicator |
boolean |
isOpen()
Open indicator |
boolean |
isScrollable()
Scrollable indicator |
boolean |
isUpdatable()
Updatable indicator |
boolean |
isValid()
Valid indicator |
DKDDO |
newObject()
Constructs a new DDO of the same type as the items in the result |
java.lang.String |
objectType()
Gets the cursor object type |
void |
open()
Opens the cursor. |
void |
open(DKNVPair[] parms)
Opens the cursor. |
void |
setPosition(int position,
java.lang.Object value)
Sets the cursor position |
void |
setToNext()
Sets cursor to point to the position of the next data object in the cursor |
void |
updateObject(DKDDO ddo)
Updates element at the current cursor position from the datastore |
Method Detail |
public boolean isScrollable() throws DKException, java.lang.Exception
public boolean isUpdatable() throws DKException, java.lang.Exception
public boolean isValid() throws DKException, java.lang.Exception
public boolean isOpen() throws DKException, java.lang.Exception
public boolean isBegin() throws DKException, java.lang.Exception
public boolean isEnd() throws DKException, java.lang.Exception
public boolean isInBetween() throws DKException, java.lang.Exception
public int getPosition() throws DKException, java.lang.Exception
public void setPosition(int position, java.lang.Object value) throws DKException, java.lang.Exception
position
- cursor position option
value
- cursor position value (optional). This value should be
set when the position is DK_CM_ABSOLUTE or DK_CM_RELATIVE. This value
is an Integer value.public void setToNext() throws DKException, java.lang.Exception
public DKDDO fetchObject() throws DKException, java.lang.Exception
public DKDDO fetchNext() throws DKException, java.lang.Exception
public boolean fetchNextN(int how_many, dkCollection collection) throws DKException, java.lang.Exception
how_many
- how many elements the user wants to be returned
in the collection.collection
- the collection where elements that are fetched
are stored.public java.lang.Object fetchObjectByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
dataItemName
- data item namepublic java.lang.Object fetchNextByName(java.lang.String dataItemName) throws DKException, java.lang.Exception
dataItemName
- data item namepublic boolean fetchNextNByName(java.lang.String dataItemName, int how_many, java.lang.Object[] array) throws DKException, java.lang.Exception
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
Note:DKUsageError exception thrown if method is not implemented
position
- cursor positionpredicate
- search predicate.public void deleteObject() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public void updateObject(DKDDO ddo) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to updatepublic DKDDO newObject() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public void addObject(DKDDO ddo) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to addpublic void open() throws DKException, java.lang.Exception
public void close() throws DKException, java.lang.Exception
public void destroy() throws DKException, java.lang.Exception
public void open(DKNVPair[] parms) throws DKException, java.lang.Exception
parms
- allows for parameters to be passed
in for the reexecution of the query.public java.lang.String datastoreName() throws java.lang.Exception
public java.lang.String datastoreType() throws java.lang.Exception
public DKHandle handle(int type) throws java.lang.Exception
type
- type of cursor handle wantedhandle(java.lang.String)
public DKHandle handle(java.lang.String type) throws java.lang.Exception
type
- type of cursor handle wantedpublic int cardinality() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public java.lang.String objectType() throws java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |