com.boomi.connector.api.result

Interface ConnectorResult

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BaseCloseableConnectorResult, BaseConnectorResult, SimpleConnectorResult

public interface ConnectorResult
extends Closeable

Abstraction for a result that can be added to an OperationResponse after the execution of a connector Operation. The general expectation for implementing classes is that closing the result (Closeable.close() and any payloads returned by getPayloads() will release all resources managed by the result.

See Also:

ResponseUtil.addPartialResult(OperationResponse, com.boomi.connector.api.TrackedData, ConnectorResult), ResponseUtil.addResult(OperationResponse, com.boomi.connector.api.TrackedData, ConnectorResult)

Method Summary

Modifier and Type	Method and Description
Iterable<? extends Payload>	getPayloads() Returns a payload iterable representing the outputs for this result.
ConnectorStatus	getStatus() Returns status of the result

Methods inherited from interface java.io.Closeable

close

Method Detail

getStatus

ConnectorStatus getStatus()

Returns status of the result

Returns:

the ConnectorStatus

getPayloads

Iterable<? extends Payload> getPayloads()
                                 throws IOException

Returns a payload iterable representing the outputs for this result.

Returns:

the payloads

Throws:

IOException