Package com.veeva.vault.sdk.api.translation

Interface FileTranslationEventHandlerContext

public interface FileTranslationEventHandlerContext

Represents the context passed to FileTranslationEventHandler.onCompleteWithSuccess(FileTranslationEventHandlerContext) or FileTranslationEventHandler.onCompleteWithError(FileTranslationEventHandlerContext) after a translation batch run finishes.

Carries both the successful and the failed positional results for the batch, along with the connection name and the rehydrated FileTranslationParameters that were attached to the original FileTranslationBatchRequest.

Method Summary

Modifier and Type	Method	Description
String	getConnectionName()	Retrieves the API name of the provider connection that was used for this translation run, as specified via FileTranslationBatchRequest.Builder.withConnectionName(String).
List<FileTranslationResultError>	getErrors()	Retrieves one result per FileTranslationInput that failed during this batch's asynchronous translation run.
<T> T	getParameter(String name, FileTranslationParameterValueType<T> valueType)	Retrieves a parameter value from the FileTranslationParameters bag that was attached to the original FileTranslationBatchRequest.
<T extends FileTranslationParameterValue> T	getParameter(String name, Class<T> returnType)	Retrieves a custom-object parameter value from the FileTranslationParameters instance that was attached to the original FileTranslationBatchRequest.
List<FileTranslationResultSuccess>	getResults()	Retrieves one result per FileTranslationInput that was successfully translated in this batch.

Method Details

getResults

List<FileTranslationResultSuccess> getResults()

Retrieves one result per FileTranslationInput that was successfully translated in this batch. Use PositionalResult.getInputPosition() to correlate each result back to its corresponding input.

Returns:

an immutable list of FileTranslationResultSuccess objects. Never null; may be empty if every input failed.

getErrors

List<FileTranslationResultError> getErrors()

Retrieves one result per FileTranslationInput that failed during this batch's asynchronous translation run. Use PositionalResult.getInputPosition() to correlate each result back to its corresponding input.

Returns:

an immutable list of FileTranslationResultError objects. Never null; may be empty if every input succeeded.

getConnectionName

String getConnectionName()

Retrieves the API name of the provider connection that was used for this translation run, as specified via FileTranslationBatchRequest.Builder.withConnectionName(String).

Returns:

the connection name. Never null.

getParameter

<T> T getParameter(String name,
 FileTranslationParameterValueType<T> valueType)

Retrieves a parameter value from the FileTranslationParameters bag that was attached to the original FileTranslationBatchRequest.

Type Parameters:

T - the expected Java type

Parameters:

name - the parameter name used when calling FileTranslationParameters.Builder.appendValue(String, Object). Cannot be null.

valueType - the type token from FileTranslationParameterValueType. Cannot be null.

Returns:

the parameter value, or null if no parameter with that name exists

getParameter

<T extends FileTranslationParameterValue> T getParameter(String name,
 Class<T> returnType)

Retrieves a custom-object parameter value from the FileTranslationParameters instance that was attached to the original FileTranslationBatchRequest.

Type Parameters:

T - the expected concrete type

Parameters:

name - the parameter name used when calling FileTranslationParameters.Builder.appendValue(String, Object). Cannot be null.

returnType - the concrete class of the FileTranslationParameterValue implementation. Cannot be null.

Returns:

the parameter value, or null if no parameter with that name exists