Package com.basis.api.admin

Interface BBjAdminIndexBuilderJob

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote

public interface BBjAdminIndexBuilderJob
extends BBjAdminPropertyWriter

Represents an individual index builder job. An index builder job is the process of building an index in the background so it allows users to continue using the file that is being indexed while the indexing is occurring. The index job may be a FULLTEXT index or a standard file index. Standard file indexes actually use an online copy job under the covers to perform the indexing.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_PATH
static final String	ID
static final String	PROGRESS
static final String	RUNNING
static final String	TIME_REMAINING

Method Summary

Modifier and Type	Method	Description
void	pause()	Pauses the index bulder job.
void	resume()	Called to resume an index builder job when the job had previously been paused.
void	terminate()	Terminates the analysis job and removes it from the queue.

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

ID

static final String ID

See Also:

• Constant Field Values

FILE_PATH

static final String FILE_PATH

See Also:

• Constant Field Values

RUNNING

static final String RUNNING

See Also:

• Constant Field Values

PROGRESS

static final String PROGRESS

See Also:

• Constant Field Values

TIME_REMAINING

static final String TIME_REMAINING

See Also:

• Constant Field Values

Method Details

resume

void resume()
     throws BBjAdminException

Called to resume an index builder job when the job had previously been paused.

Throws:

BBjAdminException

pause

void pause()
    throws BBjAdminException

Pauses the index bulder job. Use resume() to start it again.

Throws:

BBjAdminException

terminate

void terminate()
        throws BBjAdminException

Terminates the analysis job and removes it from the queue.

Throws:

BBjAdminException