Namespace: search

Methods

staticbelhop.factory.options.search.custom(filterOptions, start, size, faceted) {belhop.__.SearchOptions}

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1407

Custom search options factory. See the type this factory produces for more.

Name	Type	Default	Description
filterOptions	belhop.__.FilterOptions		nullable Filter options
start	number	0	optional Page to start from
size	number	10	optional Maximum search results
faceted	boolean	false	optional Controls faceting of the response

Returns:

Type	Description
belhop.__.SearchOptions	the BELHop type produced by this factory

Example

// search for 'foo'
var filterOpts = belhop.factory.options.filter.default('foo');
// paging search results 10 at a time, get the second page
var searchOpts = belhop.factory.options.search.custom(filterOpts, 10, 10);

staticbelhop.factory.options.search.default(value) {belhop.__.DefaultSearchOptions}

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1469

Default search options factory. See the type this factory produces for more.

Name	Type	Description
value	string	Search term

Returns:

Type	Description
belhop.__.DefaultSearchOptions	the BELHop type produced by this factory

Example

// search for 'foo' using defaults
var opts = belhop.factory.options.search.default('foo');

staticbelhop.factory.options.search.evidence(filterOptions, start, size, faceted) {belhop.__.SearchOptions}

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1489

Default evidence search options factory. See the type this factory produces for more.

Name	Type	Default	Description
filterOptions	belhop.__.FilterOptions		nullable Filter options
start	number	0	optional Page to start from
size	number	100	optional Maximum search results
faceted	boolean	false	optional Controls faceting of the response

Returns:

Type	Description
belhop.__.SearchOptions	the BELHop type produced by this factory