com.ibm.mashups.livetext
Interface CallbackModel

public CallbackModel

This API defines the various callback functions for livetext services. These callback functions should be provided by event publisher.

Method Summary

void	preProcessCallbackFunc(DOMNode domNode, Object[] livetextList, Object tagEntry) The callback function which should be provided to livetext service by the event publisher.
void	postProcessCallbackFunc(DOMNode domNode, Object[] livetextList, Object[] errors, Object tagEntry) The callback function which should be provided to livetext service by the event publisher.

Method Detail

preProcessCallbackFunc

void preProcessCallbackFunc(DOMNode domNode,
                            Object[] livetextList,
                            Object tagEntry)

The callback function which should be provided to livetext service by the event publisher. This callback function provides a means by the event publisher and for the event publisher to run some code before the HTML fragment is processed.

Parameters:

domNode - The DOM node whose decendent nodes to be parsed and processed. May be null.

livetextList - The list of the live text which will be processed. May be null.

tagEntry - The JSON object of the current tag entry used to match and process the returned nodes. Is never null.

postProcessCallbackFunc

void postProcessCallbackFunc(DOMNode domNode,
                             Object[] livetextList,
                             Object[] errors,
                             Object tagEntry)

The callback function which should be provided to livetext service by the event publisher. This callback function provides a means by the event publisher and for the event publisher to run some code after HTML fragment has been processed.

Parameters:

domNode - The DOM node whose decendent nodes to be parsed and processed. May be null.

livetextList - The list of the live text which will be processed. May be null.

errors - The list of the exceptions occurred during the parsing and node handling process. If there is no error, an empty array should be provided. May be null.

tagEntry - The JSON object of the current tag entry used to match and process the returned nodes. Is never null.