Content Engine Java API: CmIndexRequest

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable

All Known Subinterfaces:

CmTextSearchIndexRequest, CmVerityIndexRequest
```
public interface CmIndexRequest
extends RepositoryObject, IndependentlyPersistableObject
```
Represents the base class for index requests. Each index request object is associated with a CBR-enabled object. Index request objects are created by the indexing process, and cannot be created using the API. You can perform read and update operations on index request objects, and there are properties with status, failure and retry information recorded. Index request objects are assigned security from the default instance security for this class.
Metadata

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`get_CmIndexingFailureCode()` Returns the value of the CmIndexingFailureCode property.
`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.util.Date`	`get_DateRequested()` Returns the value of the DateRequested property.
`Id`	`get_Id()` Returns the value of the Id property.
`IndexArea`	`get_IndexArea()` Returns the value of the IndexArea property.
`Id`	`get_IndexationId()` Returns the value of the IndexationId property.
`IndexingOperation`	`get_IndexingOperation()` Returns the value of the IndexingOperation property.
`IndexJob`	`get_IndexJob()` Returns the value of the IndexJob property.
`IndexRequestStatus`	`get_IndexRequestStatus()` Returns the value of the IndexRequestStatus 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.Integer`	`get_RetryCount()` Returns the value of the RetryCount property.
`java.lang.Double`	`get_SequenceNumber()` Returns the value of the SequenceNumber property.
`IndependentObject`	`get_SourceObject()` Returns the value of the SourceObject 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_IndexingOperation(IndexingOperation value)` Sets the value of the IndexingOperation property.
`void`	`set_IndexRequestStatus(IndexRequestStatus value)` Sets the value of the IndexRequestStatus property.
`void`	`set_LastFailureReason(java.lang.String value)` Sets the value of the LastFailureReason property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_SourceObject(IndependentObject value)` Sets the value of the SourceObject 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_SourceObject
```
IndependentObject get_SourceObject()
```
    Returns the value of the SourceObject property. For more information, see SourceObject Property.
  - set_SourceObject
```
void set_SourceObject(IndependentObject value)
```
    Sets the value of the SourceObject property. For more information, see SourceObject Property.
  - get_IndexingOperation
```
IndexingOperation get_IndexingOperation()
```
    Returns the value of the IndexingOperation property. For more information, see IndexingOperation Property.
  - set_IndexingOperation
```
void set_IndexingOperation(IndexingOperation value)
```
    Sets the value of the IndexingOperation property. For more information, see IndexingOperation Property.
  - get_IndexationId
```
Id get_IndexationId()
```
    Returns the value of the IndexationId property. For more information, see IndexationId Property.
  - get_IndexRequestStatus
```
IndexRequestStatus get_IndexRequestStatus()
```
    Returns the value of the IndexRequestStatus property. For more information, see IndexRequestStatus Property.
  - set_IndexRequestStatus
```
void set_IndexRequestStatus(IndexRequestStatus value)
```
    Sets the value of the IndexRequestStatus property. For more information, see IndexRequestStatus Property.
  - get_DateRequested
```
java.util.Date get_DateRequested()
```
    Returns the value of the DateRequested property. For more information, see DateRequested Property.
  - get_SequenceNumber
```
java.lang.Double get_SequenceNumber()
```
    Returns the value of the SequenceNumber property. For more information, see SequenceNumber Property.
  - get_RetryCount
```
java.lang.Integer get_RetryCount()
```
    Returns the value of the RetryCount property. For more information, see RetryCount Property.
  - get_IndexJob
```
IndexJob get_IndexJob()
```
    Returns the value of the IndexJob property. For more information, see IndexJob Property.
  - get_IndexArea
```
IndexArea get_IndexArea()
```
    Returns the value of the IndexArea property. For more information, see IndexArea Property.
  - get_LastFailureReason
```
java.lang.String get_LastFailureReason()
```
    Returns the value of the LastFailureReason property. For more information, see LastFailureReason Property.
  - set_LastFailureReason
```
void set_LastFailureReason(java.lang.String value)
```
    Sets the value of the LastFailureReason property. For more information, see LastFailureReason Property.
  - get_CmIndexingFailureCode
```
java.lang.Integer get_CmIndexingFailureCode()
```
    Returns the value of the CmIndexingFailureCode property. For more information, see CmIndexingFailureCode 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_SourceObject

set_SourceObject

get_IndexingOperation

set_IndexingOperation

get_IndexationId

get_IndexRequestStatus

set_IndexRequestStatus

get_DateRequested

get_SequenceNumber

get_RetryCount

get_IndexJob

get_IndexArea

get_LastFailureReason

set_LastFailureReason

get_CmIndexingFailureCode