Application Framework Reference

Module API

someChildrenRequireDispatch()

The someChildrenRequireDispatch() helper method determines if any immediate children require a dispatched search in the context pushed to them.

Synopsis

status = someChildrenRequireDispatch( search )

Parameters

search

Object

Splunk.Search object.

Return Value

Boolean

Dispatched search required indication:

True = At least one immediate child module requires a dispatched search.

False = No child modules require a dispatched search.

Example

pushContextToChildren: function(explicitContext) {
    if (this.someChildrenRequireDispatch(search)) {
        search.abandonJob();
        this.withEachDescendant(function(module) {
            module.onBeforeJobDispatched(search);
        });
        this._fireDispatch(search);
        return;
    }
},