Package com.basis.api.admin

Interface BBjAdminBBjFile

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, 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	Description
static final int	DIRECT_FILE	DIRECT/SORT file type.
static final int	DIRECTORY_FILE	DIRECTORY file type.
static final String	FILE_TYPE
static final String	FULL_PATH
static final int	INDEXED_FILE	INDEXED file type.
static final String	KEY_SIZE
static final int	MKEYED_FILE	MKEYED file type.
static final String	NAME
static final int	PROGRAM_FILE	PROGRAM file type.
static final String	RECORD_SIZE
static final int	SERIAL_FILE	SERIAL file type.
static final int	STRING_FILE	STRING file type.
static final int	VKEYED_FILE	VKEYED file type.
static final int	XKEYED_FILE	XKEYED file type.

Method Summary

Modifier and Type	Method	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.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

Field Details

FULL_PATH

static final String FULL_PATH

See Also:

• Constant Field Values

NAME

static final String NAME

See Also:

• Constant Field Values

FILE_TYPE

static final String FILE_TYPE

See Also:

• Constant Field Values

KEY_SIZE

static final String KEY_SIZE

See Also:

• Constant Field Values

RECORD_SIZE

static final String RECORD_SIZE

See Also:

• Constant Field Values

INDEXED_FILE

static final int INDEXED_FILE

INDEXED file type.

See Also:

• Constant Field Values

SERIAL_FILE

static final int SERIAL_FILE

SERIAL file type.

See Also:

• Constant Field Values

DIRECT_FILE

static final int DIRECT_FILE

DIRECT/SORT file type.

See Also:

• Constant Field Values

STRING_FILE

static final int STRING_FILE

STRING file type.

See Also:

• Constant Field Values

PROGRAM_FILE

static final int PROGRAM_FILE

PROGRAM file type.

See Also:

• Constant Field Values

DIRECTORY_FILE

static final int DIRECTORY_FILE

DIRECTORY file type.

See Also:

• Constant Field Values

MKEYED_FILE

static final int MKEYED_FILE

MKEYED file type.

See Also:

• Constant Field Values

XKEYED_FILE

static final int XKEYED_FILE

XKEYED file type.

See Also:

• Constant Field Values

VKEYED_FILE

static final int VKEYED_FILE

VKEYED file type.

See Also:

• Constant Field Values

Method Details

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