com.basis.api.admin

Interface BBjAdminTableAnalysisJob

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote

public interface BBjAdminTableAnalysisJob
extends BBjAdminPropertyWriter

Represents an individual table analysis job. A table analysis job is the process of analyzing a single table in a particular database. The job knows certain information such as database, table, start time, user that started it, and whether it is still running. You can also terminate a running job.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATABASE_NAME
static java.lang.String	ID
static java.lang.String	LAST_RECORD_COUNT
static java.lang.String	PROGRESS
static java.lang.String	RUNNING
static java.lang.String	START_TIME
static java.lang.String	TABLE_NAME
static java.lang.String	USER

Method Summary

Modifier and Type	Method and Description
void	start() Called to start an analysis job.
void	terminate() Terminates the analysis job and removes it from the queue.

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

ID

static final java.lang.String ID

See Also:

Constant Field Values

START_TIME

static final java.lang.String START_TIME

See Also:

Constant Field Values

DATABASE_NAME

static final java.lang.String DATABASE_NAME

See Also:

Constant Field Values

TABLE_NAME

static final java.lang.String TABLE_NAME

See Also:

Constant Field Values

USER

static final java.lang.String USER

See Also:

Constant Field Values

RUNNING

static final java.lang.String RUNNING

See Also:

Constant Field Values

PROGRESS

static final java.lang.String PROGRESS

See Also:

Constant Field Values

LAST_RECORD_COUNT

static final java.lang.String LAST_RECORD_COUNT

See Also:

Constant Field Values

Method Detail

start

void start()
    throws BBjAdminException

Called to start an analysis job. It may not start immediately as it is actually placed in the queue of jobs. It will run when it is reached in the queue.

Throws:

BBjAdminException

terminate

void terminate()
        throws BBjAdminException

Terminates the analysis job and removes it from the queue.

Throws:

BBjAdminException