|
jremote jbase5.2.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JFile
The JFile object is used to query, read, and write to jBASE files.
Method Summary | |
---|---|
boolean |
clear()
Delete all records from the file. |
boolean |
close()
Closes this jBASE file. |
boolean |
delete(String recordKey)
Delete a record where the supplied recordKey is the key to the record. |
boolean |
exists(String recordKey)
This method returns true if the supplied record id exists. |
JCursor |
getCursor()
Returns a cursor to this jBASE file. |
boolean |
hasLock(String recordKey)
Check if the specified key holds a lock. |
JDynArray |
read(String recordKey)
Read a record where the supplied recordKey is the key to the record. |
JDynArray |
readU(String recordKey,
boolean blockedRead)
Read a record where the supplied recordKey is the key to the record and locks it for update. |
boolean |
releaseLock(String recordKey)
Release the update lock (if held) on the specified key. |
boolean |
releaseLocks()
Releases all locks held by this file. |
JSelectList |
select()
Returns a select list containing the record keys in this jBASE file. |
boolean |
write(String recordKey,
JDynArray record)
Write the supplied record to the jBASE file. |
boolean |
writeU(String recordKey,
JDynArray record,
boolean blockedWrite)
Write the supplied record to the jBASE file. |
Method Detail |
---|
boolean exists(String recordKey) throws JRemoteException
This method returns true if the supplied record id exists.
recordKey
-
JRemoteException
JDynArray read(String recordKey) throws JRecordNotFoundException, JRemoteException
Read a record where the supplied recordKey is the key to the record.
recordKey
-
JRecordNotFoundException
JRemoteException
JDynArray readU(String recordKey, boolean blockedRead) throws JRecordNotFoundException, JRecordLockedException, JRemoteException
Read a record where the supplied recordKey is the key to the record and locks it for update.
recordKey
- The record keyblockedRead
- Specifies whether this method call should block if the record is locked
JRecordNotFoundException
JRemoteException
JRecordLockedException
boolean write(String recordKey, JDynArray record) throws JRemoteException
Write the supplied record to the jBASE file. If an update lock was held against the supplied key, it will be released after the record has been written.
recordKey
- record
-
JRemoteException
boolean writeU(String recordKey, JDynArray record, boolean blockedWrite) throws JRecordLockedException, JRemoteException
Write the supplied record to the jBASE file. If an update lock was held against the supplied key, it will NOT be released.
recordKey
- record
- blockedWrite
- Specifies whether this method call should block if the record is already locked
JRemoteException
JRecordLockedException
boolean releaseLock(String recordKey) throws JRemoteException
Release the update lock (if held) on the specified key.
recordKey
-
JRemoteException
boolean releaseLocks() throws JRemoteException
Releases all locks held by this file.
JRemoteException
boolean hasLock(String recordKey) throws JRemoteException
Check if the specified key holds a lock.
recordKey
-
JRemoteException
boolean delete(String recordKey) throws JRemoteException
Delete a record where the supplied recordKey is the key to
the record.
Returns true if the delete was successful or false if the record
was not found.
An exception will be thrown if an error occurs whilst deleting
the record.
recordKey
-
JRemoteException
boolean close() throws JRemoteException
Closes this jBASE file.
Closing a JFile frees the associate remote system resources. Subsequent actions on this JFile object will reopen the file.
JRemoteException
JSelectList select() throws JRemoteException
Returns a select list containing the record keys in this jBASE file.
JRemoteException
JCursor getCursor() throws JRemoteException
Returns a cursor to this jBASE file.
JRemoteException
boolean clear() throws JRemoteException
Delete all records from the file.
Returns true if the operation was successful or false if the records could not be deleted.
JRemoteException
|
jremote jbase5.2.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |