com.basis.api.admin

Interface BBjAdminIndex

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote

All Known Subinterfaces:

BBjAdminBBjIndex, BBjAdminESQLIndex, BBjAdminLegacyIndex

public interface BBjAdminIndex
extends BBjAdminPropertyWriter

An individual index in a table.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KNUM
static java.lang.String	NAME
static java.lang.String	ORIGINAL_NAME
static java.lang.String	TABLE
static java.lang.String	UNIQUE

Method Summary

Modifier and Type	Method and Description
BBjAdminIndexSegment	createSegment(BBjAdminColumn p_column) Creates a new index segment for this index.
BBjAdminIndexSegment	createSegment(java.lang.String p_column) Creates a new index segment for this index.
BBjAdminList<BBjAdminProperty>	getDescriptiveProperties() Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
Index	getIndex() Gets an Index instance for this object.
BBjAdminList<BBjAdminIndexSegment>	getSegments() Returns a list of all the segments for this index.
void	setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps) Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.

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

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

ORIGINAL_NAME

static final java.lang.String ORIGINAL_NAME

See Also:

Constant Field Values

TABLE

static final java.lang.String TABLE

See Also:

Constant Field Values

KNUM

static final java.lang.String KNUM

See Also:

Constant Field Values

UNIQUE

static final java.lang.String UNIQUE

See Also:

Constant Field Values

Method Detail

getSegments

BBjAdminList<BBjAdminIndexSegment> getSegments()
                                        throws BBjAdminException

Returns a list of all the segments for this index.

Returns:

List of the segments for this index.

Throws:

BBjAdminException

createSegment

BBjAdminIndexSegment createSegment(BBjAdminColumn p_column)
                            throws BBjAdminException

Creates a new index segment for this index. p_column can be null. If null, you will need to manually set the column name and table name at some point to make the segment valid.

Parameters:

p_column - Column instance to create the segment for.

Returns:

The instance of the new BBjAdminIndexSegment that was created.

Throws:

BBjAdminException

createSegment

BBjAdminIndexSegment createSegment(java.lang.String p_column)
                            throws BBjAdminException

Creates a new index segment for this index. p_column can be null. If null, you will need to manually set the column name and table name at some point to make the segment valid.

Parameters:

p_column - Name of the column.

Returns:

A new BBjAdminIndexSegment for the specified column.

Throws:

BBjAdminException

getDescriptiveProperties

BBjAdminList<BBjAdminProperty> getDescriptiveProperties()
                                                 throws BBjAdminException

Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To get property values for general purposes, you should call the getXXX() methods.

Returns:

BBjAdminList containing BBjAdminProperty objects for each available property.

Throws:

BBjAdminException

setDescriptiveProperties

void setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps)
                       throws BBjAdminException

Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To set property values for general purposes, you should call the setXXX() methods.

Throws:

BBjAdminException

getIndex

Index getIndex()
        throws BBjAdminException

Gets an Index instance for this object. This is used for internal things and you should not use this method from the API.

Returns:

Index instance.

Throws:

BBjAdminException