Content Engine Java API: IndexJob

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable
```
public interface IndexJob
extends RepositoryObject, IndependentlyPersistableObject
```
Initiates and tracks the status of a full-text indexing operation. An IndexJob object is used to rebuild the full-text index in the event that it becomes corrupted or a configuration change requires that the full-text index be rebuilt. The following types of indexing scenarios are supported:
- Class full-text indexing (see IndexJobClassItem)
- Full-text index reindexing (see IndexJobCollectionItem)
- Single item full-text indexing (see IndexJobSingleItem)
- Full-text index resync (see CmIndexJobResyncItem)
Although currently indexed data is available while indexing is in progress, some queries will get duplicate matches from full-text searches because of matches in both the old and the new index data. Once the index job operation completes, old copies of the data are removed and duplicate matches will no longer occur.
If a base class is indexed or a full-text index is reindexed, and that index job is canceled (or terminates abnormally), indexing data for some objects will exist in two text indexes. The reason is because this type of index job does not delete the original index items until after the entire index job has completed successfully. To remove the duplicate index items, resubmit the index job for the base class or the full-text index. Note that if a single item index job or a non-base class index job is canceled, no duplicate index items will be created because these types of index jobs continuously delete individual index items from the indexes.
Most index jobs sweep the database to find classes and indexes. This sweep requires a table scan in the database (which can take a large amount of time for a large table), even if the amount of data to be indexed is minimal. Database table scans are performed once for all classes to be indexed in a table, and once for all indexes to be indexed in a table. Therefore, to minimize the number of table scans required, IBM recommends you put all classes and indexes to be indexed that are in the same table into a single index job operation.

Metadata

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`java.lang.String`	`get_DescriptiveText()` Returns the value of the DescriptiveText property.
`Id`	`get_Id()` Returns the value of the Id property.
`IndexJobItemList`	`get_IndexItems()` Returns the value of the IndexItems property.
`CmIndexRequestSet`	`get_IndexRequests()` Returns the value of the IndexRequests property.
`java.lang.Boolean`	`get_IsMigrationJob()` Returns the value of the IsMigrationJob property.
`java.lang.Boolean`	`get_JobAbortRequested()` Returns the value of the JobAbortRequested property.
`java.lang.Boolean`	`get_JobPauseRequested()` Returns the value of the JobPauseRequested property.
`IndexJobStatus`	`get_JobStatus()` Returns the value of the JobStatus property.
`java.lang.String`	`get_LastFailureReason()` Returns the value of the LastFailureReason property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`java.lang.Integer`	`get_SubmittedCount()` Returns the value of the SubmittedCount property.
`java.util.Date`	`get_TimeAllSubmitted()` Returns the value of the TimeAllSubmitted property.
`java.util.Date`	`get_TimeLastProcessed()` Returns the value of the TimeLastProcessed property.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DateLastModified(java.util.Date value)` Sets the value of the DateLastModified property.
`void`	`set_DescriptiveText(java.lang.String value)` Sets the value of the DescriptiveText property.
`void`	`set_IndexItems(IndexJobItemList value)` Sets the value of the IndexItems property.
`void`	`set_JobAbortRequested(java.lang.Boolean value)` Sets the value of the JobAbortRequested property.
`void`	`set_JobPauseRequested(java.lang.Boolean value)` Sets the value of the JobPauseRequested property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_Owner(java.lang.String value)` Sets the value of the Owner property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.

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

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_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Owner
```
java.lang.String get_Owner()
```
    Returns the value of the Owner property. For more information, see Owner Property.
  - set_Owner
```
void set_Owner(java.lang.String value)
```
    Sets the value of the Owner property. For more information, see Owner Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_DescriptiveText
```
java.lang.String get_DescriptiveText()
```
    Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - set_DescriptiveText
```
void set_DescriptiveText(java.lang.String value)
```
    Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - get_TimeLastProcessed
```
java.util.Date get_TimeLastProcessed()
```
    Returns the value of the TimeLastProcessed property. For more information, see TimeLastProcessed Property.
  - get_TimeAllSubmitted
```
java.util.Date get_TimeAllSubmitted()
```
    Returns the value of the TimeAllSubmitted property. For more information, see TimeAllSubmitted Property.
  - get_JobStatus
```
IndexJobStatus get_JobStatus()
```
    Returns the value of the JobStatus property. For more information, see JobStatus Property.
  - get_JobAbortRequested
```
java.lang.Boolean get_JobAbortRequested()
```
    Returns the value of the JobAbortRequested property. For more information, see JobAbortRequested Property.
  - set_JobAbortRequested
```
void set_JobAbortRequested(java.lang.Boolean value)
```
    Sets the value of the JobAbortRequested property. For more information, see JobAbortRequested Property.
  - get_IndexItems
```
IndexJobItemList get_IndexItems()
```
    Returns the value of the IndexItems property. For more information, see IndexItems Property.
  - set_IndexItems
```
void set_IndexItems(IndexJobItemList value)
```
    Sets the value of the IndexItems property. For more information, see IndexItems Property.
  - get_SubmittedCount
```
java.lang.Integer get_SubmittedCount()
```
    Returns the value of the SubmittedCount property. For more information, see SubmittedCount Property.
  - get_JobPauseRequested
```
java.lang.Boolean get_JobPauseRequested()
```
    Returns the value of the JobPauseRequested property. For more information, see JobPauseRequested Property.
  - set_JobPauseRequested
```
void set_JobPauseRequested(java.lang.Boolean value)
```
    Sets the value of the JobPauseRequested property. For more information, see JobPauseRequested Property.
  - get_IsMigrationJob
```
java.lang.Boolean get_IsMigrationJob()
```
    Returns the value of the IsMigrationJob property. For more information, see IsMigrationJob Property.
  - get_LastFailureReason
```
java.lang.String get_LastFailureReason()
```
    Returns the value of the LastFailureReason property. For more information, see LastFailureReason Property.
  - get_IndexRequests
```
CmIndexRequestSet get_IndexRequests()
```
    Returns the value of the IndexRequests property. For more information, see IndexRequests Property.

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

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_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_Owner

set_Owner

get_Permissions

set_Permissions

get_DescriptiveText

set_DescriptiveText

get_TimeLastProcessed

get_TimeAllSubmitted

get_JobStatus

get_JobAbortRequested

set_JobAbortRequested

get_IndexItems

set_IndexItems

get_SubmittedCount

get_JobPauseRequested

set_JobPauseRequested

get_IsMigrationJob

get_LastFailureReason

get_IndexRequests