Content Engine Java API: CmChangePreprocessorDefinition

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

DependentObject, EngineObject, RepositoryObject, java.io.Serializable
```
public interface CmChangePreprocessorDefinition
extends RepositoryObject, EngineObject, DependentObject
```
Associates a CmChangePreprocessorAction object with a class definition. When an instance of the defined class is created or updated, a change preprocessor handler referenced in the CmChangePreprocessorAction object is invoked.
A CmChangePreprocessorDefinition object is added to a ChangePreprocessorDefinitionsList object, which is set on the SubscribableClassDefinition object that represents the class definition.

A CmChangePreprocessorDefinition 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:
CmChangePreprocessorAction, SubscribableClassDefinition, Change Preprocessor Concepts

Method Summary

Methods
Modifier and Type	Method and Description
`CmChangePreprocessorAction`	`get_ChangePreprocessorAction()` Returns the value of the ChangePreprocessorAction property.
`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.
`void`	`set_ChangePreprocessorAction(CmChangePreprocessorAction value)` Sets the value of the ChangePreprocessorAction 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.

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_ChangePreprocessorAction
```
CmChangePreprocessorAction get_ChangePreprocessorAction()
```
    Returns the value of the ChangePreprocessorAction property. For more information, see ChangePreprocessorAction Property.
  - set_ChangePreprocessorAction
```
void set_ChangePreprocessorAction(CmChangePreprocessorAction value)
```
    Sets the value of the ChangePreprocessorAction property. For more information, see ChangePreprocessorAction Property.