Package com.inteliqua.rest.flow.payload

Class FlowResponseEnvelope

java.lang.Object

com.qivos.util.rest.common.envelope.APIResponseEnvelope<FlowResponsePayload>

com.inteliqua.rest.flow.payload.FlowResponseEnvelope

public class FlowResponseEnvelope
extends com.qivos.util.rest.common.envelope.APIResponseEnvelope<FlowResponsePayload>

API response envelope specifically for flow responses.

This class wraps a FlowResponsePayload inside a standardized APIResponseEnvelope to provide a consistent response format for flow-related operations.

Typical usage includes HTTP responses where the body contains flow data (e.g., metadata, configuration, execution status) wrapped in this envelope.

See Also:

FlowResponsePayload, APIResponseEnvelope

Constructor Summary

Constructors

Constructor	Description
FlowResponseEnvelope(FlowResponsePayload payload)	Constructs a new FlowResponseEnvelope with the given payload.

Method Summary

Methods inherited from class com.qivos.util.rest.common.envelope.APIResponseEnvelope

addMessage, addMessage, emptyResponse, getMessages, getPayload, isSuccess, setPayload, setSuccess

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowResponseEnvelope

public FlowResponseEnvelope(FlowResponsePayload payload)

Constructs a new FlowResponseEnvelope with the given payload.

Parameters:

payload - the flow response payload to include in the envelope