getReturnData() method

The Agentry server will call this method to obtain the data produced by the doSteplet method.

Syntax

public Object getReturnData ()

Returns

A data object or an array of data objects

Usage

It will only be called if doSteplet returned true and the steplet is being used by a data or fetch step in the Agentry application.

The objects returned by this method will be mapped to Agentry objects according to the field mappings defined in the Agentry application. This method should return either a single such object, or an array of them.

The implementation of this method typically should be very simple, in that it should just return some data that was built up in doSteplet. All of the "heavy lifting" should be done in that method.

Migration tip: If you are migrating an application from AJAPI version 4 (which returned steplet data via a special field named _returnData), just override this method to return the value of your steplet's _returnData field. If you do not override this method, the Agentry server will attempt to read that field anyways (for backwards compatibility), but this behavior is considered deprecated and should not be relied on in future versions of Agentry. It's also faster to have this method return the field, since otherwise the Agentry server will need to use reflection to read it.