org.mule.runtime.api.meta.model

Interface HasOutputModel

All Known Subinterfaces:

ConnectableComponentModel, OperationModel, SourceModel

@NoImplement
public interface HasOutputModel

Interface for a model which declares an OutputModel for its resulting payload and attributes.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
OutputModel	getOutput() Returns a MetadataType for the value that this component sets on the output Message.getPayload() field.
OutputModel	getOutputAttributes() Returns a OutputModel for the value that this component sets on the output attributes of the message.
default Optional<SampleDataProviderModel>	getSampleDataProviderModel() If the component supports providing sample data, this method returns an Optional SampleDataProviderModel which describes the used provider.

Method Detail

getOutput

OutputModel getOutput()

Returns a MetadataType for the value that this component sets on the output Message.getPayload() field.

If this executable component does not modify the payload of the Message, then a VoidType will be associated to the returned OutputModel. This, however, does not mean that the property will be set to null on the message, it means that whatever value it had before the component was executed will be preserved after it returns.

Returns:

a MetadataType representing the content type for the output messages

getOutputAttributes

OutputModel getOutputAttributes()

Returns a OutputModel for the value that this component sets on the output attributes of the message.

If this executable component does not modify the attributes of the Message, then a VoidType will be associated to the returned OutputModel. This, however, does not mean that the property will be set to null on the message, it means that whatever value it had before the component was executed will be preserved after it returns.

Returns:

a OutputModel representing the attribute types for the output messages

getSampleDataProviderModel

default Optional<SampleDataProviderModel> getSampleDataProviderModel()

If the component supports providing sample data, this method returns an Optional SampleDataProviderModel which describes the used provider.

Returns:

an Optional SampleDataProviderModel

Since:

1.4.0