Welcome to jBASE's new documentation site! Many answers to your questions can be found by searching the Knowledgebase or viewing the jBASE Documentation. We also have a Google Group for peer discussion about jBASE. If you are unable to find the information you are looking for, jBASE Support will be glad to assist in resolving your technical problems. Enjoy and please provide comments and feedback .

How can we help you?

JSelectList (jrclient API)

Class JSelectList

com.jbase.jrcs.JSelectList

public final class JSelectList
extends Object
Represents a jBASE select list variable


Constructor Summary

Modifier
Constructor and Description
protected
JSelectList(int handle, boolean indexVar, JConnection conn)

Method Summary

Modifier and Type
Method
Description
boolean
bol()
Indicates whether the select list is at its beginning
void
close()
Closes the select list and releases the server-side handle
boolean
eol()
Indicates whether the select list is at its end
protected void
finalize()

protected int
getHandle()

String
getIndexKey()
Returns the index key
String
getRecordKey()
Retrieves the record key
int
getVMCount()
Retrieves the multi-value index for the current key
boolean
isIndex()
Indicates whether this select list was generated from a jBASE index
String
readNext()
Reads the next key from the select list
void
saveList(String listName)
Saves the list under the specified name in a work file.


Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait



Constructor Detail

JSelectList

protected JSelectList(int handle, boolean indexVar, JConnection conn)


Method Detail

bol

public boolean bol() 

throws JException  

Indicates whether the select list is at its beginning. 

Returns: true if the select list is at the beginning. 

Throws: JException 



eol

public boolean eol() 

throws JException 

Indicates whether the select list is at its end. 

Returns: true if the select list is at its end. 

Throws: JException 



getIndexKey

public String getIndexKey() 

throws JException 

Returns: Index key 

Throws: JException 



isIndex

public boolean isIndex() 

throws JException 

Indicates whether this select list was generated from a jBASE index. 

Returns: true if the select list was generated from an index variable. 

Throws: JException 



readNext

public String readNext() 

throws JException 

Reads the next key from the select list. 

Returns: Next key read or blank ("") if the list is exhausted. 

Throws: JException 



getRecordKey

public String getRecordKey()  

throws JException 

Retrieves the record key. 

Returns: Record key.  

Throws: JException 



saveList

public void saveList(String listName)  

throws JException 

Saves the list under the specified name in a work file. 

Parameters: 

listName - Name to save the list as. 

Throws: JException 



getVMCount

public int getVMCount()
throws JException
Retrieves the multi-value index for the current key. 
Returns: Multi-value index. 
Throws: JException 



close

public void close()
throws JException 
Closes the select list and releases the server-side handle 
Throws: JException 



getHandle

protected int getHandle()



finalize

protected void finalize() 

Overrides: finalize in class Object


Was this article helpful?