Package com.basis.api.admin

Interface BBjAdminBBjFile_1412

All Superinterfaces:

BBjAdminBBjFile, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote

public interface BBjAdminBBjFile_1412
extends BBjAdminBBjFile

Field Summary

Fields inherited from interface com.basis.api.admin.BBjAdminBBjFile

FILE_TYPE, FULL_PATH, KEY_SIZE, NAME, RECORD_SIZE

Method Summary

Modifier and Type	Method	Description
BBjAdminOpenFile	getOpenFileExtracted(long p_lockbyte)	Returns the BBjAdminOpenFile instance of the file handle for this file that has an EXTRACT on the specified lock byte.
BBjAdminOpenFile	getOpenFileLocked()	Returns the BBjAdminOpenFile instance of the file handle who has this file currently locked.

Methods inherited from interface com.basis.api.admin.BBjAdminBBjFile

getKeyDescriptions, getRecordCount

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Method Details

getOpenFileExtracted

BBjAdminOpenFile getOpenFileExtracted(long p_lockbyte)
                               throws BBjAdminException

Returns the BBjAdminOpenFile instance of the file handle for this file that has an EXTRACT on the specified lock byte. If there are no extracts on the lock byte, returns null. To acquire the lock byte in a BBx program, make a call to TCB(10) in the error handler for a failed file operation on an EXTRACTed record. TCB(10) returns the lock byte which can be passed into this method.

Parameters:

p_lockbyte - The lock byte of the record of interest. From a BBx program, call TCB(10) to acquire the lock byte in the error handler for a failed file operation.

Returns:

BBjAdminOpenFile instance of the file handle for this file that has an EXTRACT on the specified lock byte.

Throws:

BBjAdminException

getOpenFileLocked

BBjAdminOpenFile getOpenFileLocked()
                            throws BBjAdminException

Returns the BBjAdminOpenFile instance of the file handle who has this file currently locked.

Returns:

BBjAdminOpenFile instance of the file handle who has this file currently locked.

Throws:

BBjAdminException