com.boomi.connector.api

Interface OperationResponse

All Superinterfaces:

PayloadMetadataFactory

All Known Implementing Classes:

SimpleOperationResponse

public interface OperationResponse
extends PayloadMetadataFactory

Interface for processing the results of an Operation execution.

Method Summary

Modifier and Type	Method and Description
void	addCombinedResult(Iterable<? extends TrackedData> inputs, OperationStatus status, String statusCode, String statusMessage, Payload payload) Adds a single result for a multiple inputs.
void	addEmptyResult(TrackedData input, OperationStatus status, String statusCode, String statusMessage) Adds a single empty result for a single input.
void	addErrorResult(TrackedData input, OperationStatus status, String statusCode, String statusMessage, Throwable t) Adds a single error result for a single input.
void	addPartialResult(Iterable<? extends TrackedData> inputs, OperationStatus status, String statusCode, String statusMessage, Payload payload) Adds a single result which is one of multiple results for a group of inputs.
void	addPartialResult(TrackedData input, OperationStatus status, String statusCode, String statusMessage, Payload payload) Adds a single result which is one of multiple results for a single input.
void	addResult(TrackedData input, OperationStatus status, String statusCode, String statusMessage, Payload payload) Adds a single result for a single input.
void	finishPartialResult(Iterable<? extends TrackedData> inputs) Indicates that a group of inputs has added all partial results.
void	finishPartialResult(TrackedData input) Indicates that a single input has added all partial results.
Logger	getLogger() Returns a logger which can be used to log general information regarding this operation execution.

Methods inherited from interface com.boomi.connector.api.PayloadMetadataFactory

createMetadata

Method Detail

getLogger

Logger getLogger()

Returns a logger which can be used to log general information regarding this operation execution.

Note, events specific to a TrackedData should be logged using the logger retrieved from TrackedData.getLogger().

Returns:

an execution logger

addResult

void addResult(TrackedData input,
               OperationStatus status,
               String statusCode,
               String statusMessage,
               Payload payload)

Adds a single result for a single input.

Note, each TrackedData should only be passed once to exactly one of the addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), addCombinedResult(java.lang.Iterable<? extends com.boomi.connector.api.TrackedData>, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), finishPartialResult(com.boomi.connector.api.TrackedData), addEmptyResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String), or addErrorResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, java.lang.Throwable) methods. If an input is not passed to one of these methods, it will be marked as "failed" when the operation completes.

Parameters:

input - the input which generated this result

status - the simple status for this result

statusCode - the optional, implementation specific code for this result. this value is intended to be something which could be handled programmatically

statusMessage - the optional, implementation specific message for this result. this value is intended to be something for a user to view

payload - the optional payload for this result

addCombinedResult

void addCombinedResult(Iterable<? extends TrackedData> inputs,
                       OperationStatus status,
                       String statusCode,
                       String statusMessage,
                       Payload payload)

Adds a single result for a multiple inputs.

Note, each TrackedData should only be passed once to exactly one of the addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), addCombinedResult(java.lang.Iterable<? extends com.boomi.connector.api.TrackedData>, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), finishPartialResult(com.boomi.connector.api.TrackedData), addEmptyResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String), or addErrorResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, java.lang.Throwable) methods. If an input is not passed to one of these methods, it will be marked as "failed" when the operation completes.

Parameters:

inputs - the multiple inputs which generated this result

status - the simple status for this result

statusCode - the optional, implementation specific code for this result. this value is intended to be something which could be handled programmatically

statusMessage - the optional, implementation specific message for this result. this value is intended to be something for a user to view

payload - the optional payload for this result

addPartialResult

void addPartialResult(TrackedData input,
                      OperationStatus status,
                      String statusCode,
                      String statusMessage,
                      Payload payload)

Adds a single result which is one of multiple results for a single input. This method may be called as many times as necessary for the same input until that input has been passed to finishPartialResult(com.boomi.connector.api.TrackedData).

Parameters:

input - the single input which generated this result

status - the simple status for this result

statusCode - the optional, implementation specific code for this result. this value is intended to be something which could be handled programmatically

statusMessage - the optional, implementation specific message for this result. this value is intended to be something for a user to view

payload - the optional payload for this result

finishPartialResult

void finishPartialResult(TrackedData input)

Indicates that a single input has added all partial results.

Note, each TrackedData should only be passed once to exactly one of the addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), addCombinedResult(java.lang.Iterable<? extends com.boomi.connector.api.TrackedData>, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), finishPartialResult(com.boomi.connector.api.TrackedData), addEmptyResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String), or addErrorResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, java.lang.Throwable) methods. If an input is not passed to one of these methods, it will be marked as "failed" when the operation completes.

Parameters:

input - the single input which has had all partial results added

addPartialResult

void addPartialResult(Iterable<? extends TrackedData> inputs,
                      OperationStatus status,
                      String statusCode,
                      String statusMessage,
                      Payload payload)

Adds a single result which is one of multiple results for a group of inputs. This method may be called as many times as necessary for the same inputs until they have been passed to finishPartialResult(Iterable).

Parameters:

inputs - the group of inputs which generated this result

status - the simple status for this result

statusCode - the optional, implementation specific code for this result. this value is intended to be something which could be handled programmatically

statusMessage - the optional, implementation specific message for this result. this value is intended to be something for a user to view

payload - the optional payload for this result

finishPartialResult

void finishPartialResult(Iterable<? extends TrackedData> inputs)

Indicates that a group of inputs has added all partial results.

Note, each TrackedData should only be passed once to exactly one of the addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), addCombinedResult(java.lang.Iterable<? extends com.boomi.connector.api.TrackedData>, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), finishPartialResult(com.boomi.connector.api.TrackedData), addEmptyResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String), or addErrorResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, java.lang.Throwable) methods. If an input is not passed to one of these methods, it will be marked as "failed" when the operation completes.

Parameters:

inputs - the group of inputs which has had all partial results added

addEmptyResult

void addEmptyResult(TrackedData input,
                    OperationStatus status,
                    String statusCode,
                    String statusMessage)

Adds a single empty result for a single input. This is different from calling addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload) with a null or empty Payload, as that call will generate an empty output document, but this call will not generate any output document.

Note, each TrackedData should only be passed once to exactly one of the addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), addCombinedResult(java.lang.Iterable<? extends com.boomi.connector.api.TrackedData>, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), finishPartialResult(com.boomi.connector.api.TrackedData), addEmptyResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String), or addErrorResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, java.lang.Throwable) methods. If an input is not passed to one of these methods, it will be marked as "failed" when the operation completes.

Parameters:

input - the input which generated this result

addErrorResult

void addErrorResult(TrackedData input,
                    OperationStatus status,
                    String statusCode,
                    String statusMessage,
                    Throwable t)

Adds a single error result for a single input. This is different from calling addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload) with a null or empty Payload, as that call will generate an empty output document, but this call will not generate any output document.

Note, each TrackedData should only be passed once to exactly one of the addResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), addCombinedResult(java.lang.Iterable<? extends com.boomi.connector.api.TrackedData>, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, com.boomi.connector.api.Payload), finishPartialResult(com.boomi.connector.api.TrackedData), addEmptyResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String), or addErrorResult(com.boomi.connector.api.TrackedData, com.boomi.connector.api.OperationStatus, java.lang.String, java.lang.String, java.lang.Throwable) methods. If an input is not passed to one of these methods, it will be marked as "failed" when the operation completes.

Parameters:

input - the input which generated this result

status - the operation status, must be an error status, may not be OperationStatus.SUCCESS