doSteplet() method

Syntax

public abstract boolean doSteplet () throws AgentryException

Returns

For fetch, push, transaction update step, and service event read, data, and update steplets: true if the steplet produced data that the Agentry server should read from the _returnData field, or false if no data was produced. For transaction data state and error handling steplets, and service event error handling steplets: the meaning of the return value is configured in the Agentry Editor.

Exceptions

• AgentryException class – if an error occurs.

Usage

A steplet can obtain various parameters from Agentry via the session information stored in the _session member variable. Steplet objects that retrieve data that will be read by the Agentry server should store that data in a public field named _returnData, which the Agentry Server will read via reflection if this method returns true.

A steplet can throw StepletStopException to stop processing of itself but allow processing of subsequence steplets in a session to continue, or it can throw StepletAbortException to stop processing of itself and any subsequent steplets in the session. It can also throw a BusinessLogicException exception to report an error message to the client's transmit window. Steplets used in transactions can also throw any of the transaction-related exceptions ( FatalTransactionException, RetryTransactionWithChangeException, and RetryTransactionException).