com.basis.api.admin

Interface BBjAdminBBjFile

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote

All Known Subinterfaces:

BBjAdminBBjFile_1412

public interface BBjAdminBBjFile
extends BBjAdminPropertyWriter

Contains information about a data file examined by the BBj file system. This is different than a BBjAdminFile in that a BBjAdminFile is examined using the OS file system. So, any non-BASIS data file will show as a type STRING for the file type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_TYPE
static java.lang.String	FULL_PATH
static java.lang.String	KEY_SIZE
static java.lang.String	NAME
static java.lang.String	RECORD_SIZE

Method Summary

Modifier and Type	Method and Description
BBjAdminList<KeyDescription>	getKeyDescriptions() Returns a list of KeyDescription objects for the keys on the file if it is a multi-keyed file.
long	getRecordCount() Returns number of records currently in the data file at the time this method is called.

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

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

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

Field Detail

FULL_PATH

static final java.lang.String FULL_PATH

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

FILE_TYPE

static final java.lang.String FILE_TYPE

See Also:

Constant Field Values

KEY_SIZE

static final java.lang.String KEY_SIZE

See Also:

Constant Field Values

RECORD_SIZE

static final java.lang.String RECORD_SIZE

See Also:

Constant Field Values

Method Detail

getRecordCount

long getRecordCount()
             throws BBjAdminException

Returns number of records currently in the data file at the time this method is called.

Throws:

BBjAdminException

getKeyDescriptions

BBjAdminList<KeyDescription> getKeyDescriptions()
                                         throws BBjAdminException

Returns a list of KeyDescription objects for the keys on the file if it is a multi-keyed file. Single-keyed files will not return any information in this method, but rather, you should check the KEY_SIZE property for that information.

Throws:

BBjAdminException