Content Engine Java API: CmTextSearchIndex

All Superinterfaces:

DependentObject, EngineObject, RepositoryObject, java.io.Serializable
```
public interface CmTextSearchIndex
extends RepositoryObject, EngineObject, DependentObject
```
Represents an IBM® Content Search Services index, which holds the full-text indexing information that is created, updated, and searched by an IBM Content Search Services server. The Content Engine creates IBM Content Search Services indexes automatically as needed within an IBM Content Search Services index area. Each IBM Content Search Services index can be associated with only a single IBM Content Search Services index area. An IBM Content Search Services index specifies its status with the ResourceStatus property. When an index reaches its full capacity, its status is automatically set to FULL. Within a given object store, you can associate an IBM Content Search Services index with a date-valued property that acts as a date partition constraint and a string-valued property that acts as a string partition constraint.
Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject

Method Summary

Methods
Modifier and Type	Method and Description
`IdList`	`get_BaseClassIds()` Returns the value of the BaseClassIds property.
`Id`	`get_CurrentIndexServer()` Returns the value of the CurrentIndexServer property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Double`	`get_IndexedObjectCount()` Returns the value of the IndexedObjectCount property.
`IndexingStatus`	`get_IndexingStatus()` Returns the value of the IndexingStatus property.
`java.lang.String`	`get_IndexName()` Returns the value of the IndexName property.
`CmIndexPartitionConstraintList`	`get_IndexPartitionConstraints()` Returns the value of the IndexPartitionConstraints property.
`java.lang.Double`	`get_IndexSizeKbytes()` Returns the value of the IndexSizeKbytes property.
`java.util.Date`	`get_LeaseExpiryTime()` Returns the value of the LeaseExpiryTime property.
`ResourceStatus`	`get_ResourceStatus()` Returns the value of the ResourceStatus property.
`void`	`set_BaseClassIds(IdList value)` Sets the value of the BaseClassIds property.
`void`	`set_ResourceStatus(ResourceStatus value)` Sets the value of the ResourceStatus property.

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

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

- Method Detail
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - get_BaseClassIds
```
IdList get_BaseClassIds()
```
    Returns the value of the BaseClassIds property. For more information, see BaseClassIds Property.
  - set_BaseClassIds
```
void set_BaseClassIds(IdList value)
```
    Sets the value of the BaseClassIds property. For more information, see BaseClassIds Property.
  - get_IndexName
```
java.lang.String get_IndexName()
```
    Returns the value of the IndexName property. For more information, see IndexName Property.
  - get_ResourceStatus
```
ResourceStatus get_ResourceStatus()
```
    Returns the value of the ResourceStatus property. For more information, see ResourceStatus Property.
  - set_ResourceStatus
```
void set_ResourceStatus(ResourceStatus value)
```
    Sets the value of the ResourceStatus property. For more information, see ResourceStatus Property.
  - get_IndexSizeKbytes
```
java.lang.Double get_IndexSizeKbytes()
```
    Returns the value of the IndexSizeKbytes property. For more information, see IndexSizeKbytes Property.
  - get_IndexedObjectCount
```
java.lang.Double get_IndexedObjectCount()
```
    Returns the value of the IndexedObjectCount property. For more information, see IndexedObjectCount Property.
  - get_CurrentIndexServer
```
Id get_CurrentIndexServer()
```
    Returns the value of the CurrentIndexServer property. For more information, see CurrentIndexServer Property.
  - get_LeaseExpiryTime
```
java.util.Date get_LeaseExpiryTime()
```
    Returns the value of the LeaseExpiryTime property. For more information, see LeaseExpiryTime Property.
  - get_IndexPartitionConstraints
```
CmIndexPartitionConstraintList get_IndexPartitionConstraints()
```
    Returns the value of the IndexPartitionConstraints property. For more information, see IndexPartitionConstraints Property.
  - get_IndexingStatus
```
IndexingStatus get_IndexingStatus()
```
    Returns the value of the IndexingStatus property. For more information, see IndexingStatus Property.

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

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

get_Id

get_DateCreated

get_BaseClassIds

set_BaseClassIds

get_IndexName

get_ResourceStatus

set_ResourceStatus

get_IndexSizeKbytes

get_IndexedObjectCount

get_CurrentIndexServer

get_LeaseExpiryTime

get_IndexPartitionConstraints

get_IndexingStatus