Interface FileTranslationParameterValue

All Superinterfaces:
Serializable
All Known Subinterfaces:
DocumentCreationHandlerParameters, DocumentUpdateHandlerParameters, FileTranslationPlatformHandlerParameters

public interface FileTranslationParameterValue extends Serializable
Represents a marker interface for custom parameter value objects that can be stored in a FileTranslationParameters instance and retrieved in a FileTranslationEventHandler.

Implement this interface to pass structured, use-case-specific data through the async translation boundary. Retrieve instances in the event handler via FileTranslationEventHandlerContext.getParameter(String, Class).

Serialization constraint: implementations may only declare non-static fields of scalar types (String, Boolean, BigDecimal, LocalDate, ZonedDateTime) or Collection/Map of those scalar types. Nested FileTranslationParameterValue objects are also permitted. All other field types will cause a serialization failure at runtime.

Implementations must define a public no-arg constructor.

See Also: