CmTextIndexingPreprocessorDefinition

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

DependentObject, EngineObject, RepositoryObject, java.io.Serializable
```
public interface CmTextIndexingPreprocessorDefinition
extends RepositoryObject, EngineObject, DependentObject
```
Associates a CmTextIndexingPreprocessorAction object with a class definition. When an instance of the defined class is full text indexed, a text indexing preprocessor handler referenced in the CmTextIndexingPreprocessorAction object is invoked.
A CmTextIndexingPreprocessorDefinition object is added to a TextIndexingPreprocessorDefinitionsList object, which is set on the SubscribableClassDefinition object that represents the class definition.

A CmTextIndexingPreprocessorDefinition object can be disabled at the class scope; therefore, the action it references will not be invoked within a given class hierarchy.

Metadata

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

See Also:

CmTextIndexingPreprocessorAction, SubscribableClassDefinition, Text Indexing Preprocessor Concepts

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Boolean`	`get_IsEnabled()` Returns the value of the IsEnabled property.
`CmTextIndexingPreprocessorAction`	`get_TextIndexingPreprocessorAction()` Returns the value of the TextIndexingPreprocessorAction property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_IsEnabled(java.lang.Boolean value)` Sets the value of the IsEnabled property.
`void`	`set_TextIndexingPreprocessorAction(CmTextIndexingPreprocessorAction value)` Sets the value of the TextIndexingPreprocessorAction 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_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - set_DisplayName
```
void set_DisplayName(java.lang.String value)
```
    Sets the value of the DisplayName property. For more information, see DisplayName Property.
  - get_IsEnabled
```
java.lang.Boolean get_IsEnabled()
```
    Returns the value of the IsEnabled property. For more information, see IsEnabled Property.
  - set_IsEnabled
```
void set_IsEnabled(java.lang.Boolean value)
```
    Sets the value of the IsEnabled property. For more information, see IsEnabled Property.
  - get_TextIndexingPreprocessorAction
```
CmTextIndexingPreprocessorAction get_TextIndexingPreprocessorAction()
```
    Returns the value of the TextIndexingPreprocessorAction property. For more information, see TextIndexingPreprocessorAction Property.
  - set_TextIndexingPreprocessorAction
```
void set_TextIndexingPreprocessorAction(CmTextIndexingPreprocessorAction value)
```
    Sets the value of the TextIndexingPreprocessorAction property. For more information, see TextIndexingPreprocessorAction Property.