com.busit

Interface Producer

public interface Producer

Method Summary

Methods

Modifier and Type	Method and Description
Message	produce(Channel out, Content data) Produce data for the selected output channel.
Message	sample(Channel out) Produce sample data for the selected output channel Upon activation, this method will be called once for each meaningful 'out' (that have at least one chained app).
boolean	test() Test preconditions for this app.

Method Detail

produce

Message produce(Channel out,
              Content data)
                throws Exception

Produce data for the selected output channel. In case activation of this app was triggered by a CRON, this method will be called only once for the target 'out' channel and the 'data' will be null.

Parameters:

out - the desired output channel

data - Optional PUSH data that triggered activation of this method

Returns:

The produced message(s) or null if nothing is produced.

Throws:

Exception - If any exception is thrown, it has the same effect as calling App.notifyOwner(e.getMessage(), e) and then returning null.

sample

Message sample(Channel out)
               throws Exception

Produce sample data for the selected output channel Upon activation, this method will be called once for each meaningful 'out' (that have at least one chained app).

Parameters:

out - The desired output channel.

Returns:

The produced message or null if nothing is produced.

Throws:

Exception - If any exception is thrown, it has the same effect as calling App.notifyOwner(e.getMessage(), e) and then returning null.

test

boolean test()
             throws Exception

Test preconditions for this app. The current instance will be fully populated and configured. Implementation should check its own dependencies and the current settings.

Returns:

true if the app instance meets all preconditions, false otherwise.

Throws:

Exception - If any exception is thrown, it has the same effect as calling App.notifyOwner(e.getMessage(), e), and then returning false.