Content Engine Java API: CmTextSearchIndexArea

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, IndexArea, RepositoryObject, java.io.Serializable, Subscribable
```
public interface CmTextSearchIndexArea
extends RepositoryObject, IndexArea
```
Represents the configuration of an IBM® Content Search Services index area. An IBM Content Search Services index area holds indexes that are created, updated, and queried by IBM Content Search Services servers. An IBM Content Search Services index area and the IBM Content Search Services servers that use it must all belong to the same site. Within each index area, you can control the number of indexes that can be created and the capacity of each of these indexes. In addition, you can specify the root directory to use for storing these indexes.
New indexes can only be created in an index area if the ResourceStatus property is set to OPEN. However, indexes in an index area are always searched during a query, regardless of the setting of the ResourceStatus property. If the number of indexes in an index area is equal to the value of the MaxIndexes property, the ResourceStatus property is automatically set to FULL by the Content Engine server. This setting indicates that no more indexes can be created in the index area. Users are not allowed to set the status of an index area to FULL; only the Content Engine server can set this value. If there are no open index areas available, the Content Engine server searches for the an index area having a status of STANDBY and sets it to OPEN.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: IndexArea

Method Summary

Methods
Modifier and Type	Method and Description
`CmTextSearchAffinityGroup`	`get_AffinityGroup()` Returns the value of the AffinityGroup property.
`java.lang.Integer`	`get_CmStandbyActivationPriority()` Returns the value of the CmStandbyActivationPriority property.
`java.lang.Integer`	`get_MaxIndexes()` Returns the value of the MaxIndexes property.
`java.lang.Double`	`get_MaxObjectsPerIndex()` Returns the value of the MaxObjectsPerIndex property.
`java.lang.Double`	`get_MaxSizePerIndexKbytes()` Returns the value of the MaxSizePerIndexKbytes property.
`java.lang.String`	`get_RootDirectoryPath()` Returns the value of the RootDirectoryPath property.
`CmTextSearchIndexList`	`get_TextSearchIndexes()` Returns the value of the TextSearchIndexes property.
`void`	`set_AffinityGroup(CmTextSearchAffinityGroup value)` Sets the value of the AffinityGroup property.
`void`	`set_CmStandbyActivationPriority(java.lang.Integer value)` Sets the value of the CmStandbyActivationPriority property.
`void`	`set_MaxIndexes(java.lang.Integer value)` Sets the value of the MaxIndexes property.
`void`	`set_MaxObjectsPerIndex(java.lang.Double value)` Sets the value of the MaxObjectsPerIndex property.
`void`	`set_MaxSizePerIndexKbytes(java.lang.Double value)` Sets the value of the MaxSizePerIndexKbytes property.
`void`	`set_RootDirectoryPath(java.lang.String value)` Sets the value of the RootDirectoryPath property.
`void`	`set_TextSearchIndexes(CmTextSearchIndexList value)` Sets the value of the TextSearchIndexes property.

Methods inherited from interface com.filenet.api.admin.IndexArea
get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Permissions, get_ResourceStatus, get_Site, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Permissions, set_ResourceStatus, set_Site

Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore

Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_RootDirectoryPath
```
java.lang.String get_RootDirectoryPath()
```
    Returns the value of the RootDirectoryPath property. For more information, see RootDirectoryPath Property.
  - set_RootDirectoryPath
```
void set_RootDirectoryPath(java.lang.String value)
```
    Sets the value of the RootDirectoryPath property. For more information, see RootDirectoryPath Property.
  - get_TextSearchIndexes
```
CmTextSearchIndexList get_TextSearchIndexes()
```
    Returns the value of the TextSearchIndexes property. For more information, see TextSearchIndexes Property.
  - set_TextSearchIndexes
```
void set_TextSearchIndexes(CmTextSearchIndexList value)
```
    Sets the value of the TextSearchIndexes property. For more information, see TextSearchIndexes Property.
  - get_MaxIndexes
```
java.lang.Integer get_MaxIndexes()
```
    Returns the value of the MaxIndexes property. For more information, see MaxIndexes Property.
  - set_MaxIndexes
```
void set_MaxIndexes(java.lang.Integer value)
```
    Sets the value of the MaxIndexes property. For more information, see MaxIndexes Property.
  - get_MaxObjectsPerIndex
```
java.lang.Double get_MaxObjectsPerIndex()
```
    Returns the value of the MaxObjectsPerIndex property. For more information, see MaxObjectsPerIndex Property.
  - set_MaxObjectsPerIndex
```
void set_MaxObjectsPerIndex(java.lang.Double value)
```
    Sets the value of the MaxObjectsPerIndex property. For more information, see MaxObjectsPerIndex Property.
  - get_MaxSizePerIndexKbytes
```
java.lang.Double get_MaxSizePerIndexKbytes()
```
    Returns the value of the MaxSizePerIndexKbytes property. For more information, see MaxSizePerIndexKbytes Property.
  - set_MaxSizePerIndexKbytes
```
void set_MaxSizePerIndexKbytes(java.lang.Double value)
```
    Sets the value of the MaxSizePerIndexKbytes property. For more information, see MaxSizePerIndexKbytes Property.
  - get_CmStandbyActivationPriority
```
java.lang.Integer get_CmStandbyActivationPriority()
```
    Returns the value of the CmStandbyActivationPriority property. For more information, see CmStandbyActivationPriority Property.
  - set_CmStandbyActivationPriority
```
void set_CmStandbyActivationPriority(java.lang.Integer value)
```
    Sets the value of the CmStandbyActivationPriority property. For more information, see CmStandbyActivationPriority Property.
  - get_AffinityGroup
```
CmTextSearchAffinityGroup get_AffinityGroup()
```
    Returns the value of the AffinityGroup property. For more information, see AffinityGroup Property.
  - set_AffinityGroup
```
void set_AffinityGroup(CmTextSearchAffinityGroup value)
```
    Sets the value of the AffinityGroup property. For more information, see AffinityGroup Property.

Methods inherited from interface com.filenet.api.admin.IndexArea

Methods inherited from interface com.filenet.api.core.RepositoryObject

Methods inherited from interface com.filenet.api.core.Subscribable

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_RootDirectoryPath

set_RootDirectoryPath

get_TextSearchIndexes

set_TextSearchIndexes

get_MaxIndexes

set_MaxIndexes

get_MaxObjectsPerIndex

set_MaxObjectsPerIndex

get_MaxSizePerIndexKbytes

set_MaxSizePerIndexKbytes

get_CmStandbyActivationPriority

set_CmStandbyActivationPriority

get_AffinityGroup

set_AffinityGroup