BBjAdminIndexSegment

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote

All Known Subinterfaces:

BBjAdminBBjIndexSegment, BBjAdminESQLIndexSegment, BBjAdminLegacyIndexSegment
```
public interface BBjAdminIndexSegment
extends BBjAdminPropertyWriter
```
An individual index in a table.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COLUMN`
`static java.lang.String`	`DESCENDING`
`static java.lang.String`	`FIELD`
`static java.lang.String`	`INDEX`
`static java.lang.String`	`LENGTH`
`static java.lang.String`	`OFFSET`
`static java.lang.String`	`SPECIAL`
`static int`	`SPECIAL_BUSINESS_MATH`
`static int`	`SPECIAL_CASE_INSENSITIVE`
`static int`	`SPECIAL_NORMAL`
`static int`	`SPECIAL_ORDERED_NUMERIC`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type Method and Description

IndexSegment getIndexSegment()
Gets an IndexSegment instance for this.
- 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IndexSegment`	`getIndexSegment()` Gets an IndexSegment instance for this.

- Field Detail
  - INDEX
```
static final java.lang.String INDEX
```
    See Also:
    
    Constant Field Values
  - COLUMN
```
static final java.lang.String COLUMN
```
    See Also:
    
    Constant Field Values
  - FIELD
```
static final java.lang.String FIELD
```
    See Also:
    
    Constant Field Values
  - OFFSET
```
static final java.lang.String OFFSET
```
    See Also:
    
    Constant Field Values
  - LENGTH
```
static final java.lang.String LENGTH
```
    See Also:
    
    Constant Field Values
  - DESCENDING
```
static final java.lang.String DESCENDING
```
    See Also:
    
    Constant Field Values
  - SPECIAL
```
static final java.lang.String SPECIAL
```
    See Also:
    
    Constant Field Values
  - SPECIAL_NORMAL
```
static final int SPECIAL_NORMAL
```
    See Also:
    
    Constant Field Values
  - SPECIAL_BUSINESS_MATH
```
static final int SPECIAL_BUSINESS_MATH
```
    See Also:
    
    Constant Field Values
  - SPECIAL_ORDERED_NUMERIC
```
static final int SPECIAL_ORDERED_NUMERIC
```
    See Also:
    
    Constant Field Values
  - SPECIAL_CASE_INSENSITIVE
```
static final int SPECIAL_CASE_INSENSITIVE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getIndexSegment
```
IndexSegment getIndexSegment()
                      throws BBjAdminException
```
    Gets an IndexSegment instance for this. This is only for internal use. Do not used this method when using the API.
    
    Returns:
    
    An IndexSegment.
    
    Throws:
    
    BBjAdminException

Interface BBjAdminIndexSegment

Field Summary

Method Summary

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

Field Detail

INDEX

COLUMN

FIELD

OFFSET

LENGTH

DESCENDING

SPECIAL

SPECIAL_NORMAL

SPECIAL_BUSINESS_MATH

SPECIAL_ORDERED_NUMERIC

SPECIAL_CASE_INSENSITIVE

Method Detail

getIndexSegment