Content Engine Java API: ChangePreprocessor

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface ChangePreprocessor
```
An interface to be implemented as a change preprocessor handler that runs on the server. A change preprocessor handler is referenced by a CmChangePreprocessorAction object. A CmChangePreprocessorAction object is set on a CmChangePreprocessorDefinition object, which is associated with a class definition. When an instance of the class is created or updated, the change preprocessor handler is invoked.
When implementing a change preprocessor, consider the following points:
- The preprocessor can only alter property values. Such updates will be subject to security and server constraint checking following the updates.
- An exception will return to the client and the transaction will be rolled back.
- You can implement a change preprocessor handler as a Java or JavaScript component. You can check in a Java change preprocessor as a CodeModule object, or you can specify a Java change preprocessor in the classpath of the application server where the Content Engine is running.
See Also:
Change Preprocessor Concepts

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`preprocessObjectChange(IndependentlyPersistableObject sourceObj)` Invoked when the class definition (or a superclass) of a new or changed object is configured with an enabled change preprocessor definition.

- Method Detail
  - preprocessObjectChange
```
boolean preprocessObjectChange(IndependentlyPersistableObject sourceObj)
                               throws EngineRuntimeException
```
    Invoked when the class definition (or a superclass) of a new or changed object is configured with an enabled change preprocessor definition. Implement this method with the actions to be taken.
    
    Parameters:
    sourceObj - The object being created or changed.
    
    Throws:
    
    EngineRuntimeException