Package com.basis.api.admin

Interface BBjAdminOpenFile

All Superinterfaces:

BBjAdminPropertyReader, Comparable<BBjAdminOpenFile>, Remote

public interface BBjAdminOpenFile
extends BBjAdminPropertyReader, Comparable<BBjAdminOpenFile>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADVISORY	Whether advisory locking was enabled.
static final String	EXTRACTED	A long value representing the lock byte of the extracted record if currently extracted.
static final String	HOST	IP address for the client who opened this file.
static final String	ID	A unique identifier for this open file.
static final String	INSTANCE_ID	Returns the java.lang.System.identityHashCode() value of an internal file handle object as a string.
static final String	LOCKED	Whether the file is locked or not.
static final String	MESSAGE	Contains the string in the STBL !SESSIONINFO for the interpreter if present.
static final String	MODES	The MODE string used by the OPEN or SQLOPEN call in the interpreter.
static final String	NAME	Name of the file.
static final String	OPEN_TYPE	An integer value indicating how the file was opened.
static final String	OPEN_TYPE_STRING	A human-readable string indicating how the file was opened.
static final String	READ_ONLY	Whether the file was opened as read-only.
static final String	USER	The user who opened this file.

Method Summary

Modifier and Type	Method	Description
void	forceClose()	Force open file to close.

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 java.lang.Comparable

compareTo

Field Details

NAME

static final String NAME

Name of the file.

See Also:

• Constant Field Values

ID

static final String ID

A unique identifier for this open file. Files opened by BBj using OPEN will begin with BBJ: and include the INFO(3,0) value following the colon.

See Also:

• Constant Field Values

USER

static final String USER

The user who opened this file.

See Also:

• Constant Field Values

HOST

static final String HOST

IP address for the client who opened this file.

See Also:

• Constant Field Values

LOCKED

static final String LOCKED

Whether the file is locked or not.

See Also:

• Constant Field Values

EXTRACTED

static final String EXTRACTED

A long value representing the lock byte of the extracted record if currently extracted.

See Also:

• Constant Field Values

ADVISORY

static final String ADVISORY

Whether advisory locking was enabled.

See Also:

• Constant Field Values

READ_ONLY

static final String READ_ONLY

Whether the file was opened as read-only.

See Also:

• Constant Field Values

OPEN_TYPE

static final String OPEN_TYPE

An integer value indicating how the file was opened. 0 - Normal, 1 - String, 2 - Indexed.

See Also:

• Constant Field Values

OPEN_TYPE_STRING

static final String OPEN_TYPE_STRING

A human-readable string indicating how the file was opened. Normal, String, or Indexed.

See Also:

• Constant Field Values

INSTANCE_ID

static final String INSTANCE_ID

Returns the java.lang.System.identityHashCode() value of an internal file handle object as a string.

See Also:

• Constant Field Values

MESSAGE

static final String MESSAGE

Contains the string in the STBL !SESSIONINFO for the interpreter if present.

See Also:

• Constant Field Values

MODES

static final String MODES

The MODE string used by the OPEN or SQLOPEN call in the interpreter.

See Also:

• Constant Field Values

Method Details

forceClose

void forceClose()
         throws BBjAdminException

Force open file to close.

Throws:

BBjAdminException