com.box.sdk

Class BoxSearch

Object

BoxSearch

public class BoxSearch
extends Object

Represents search on Box. This class can be used to search through your box instance. In addition this lets you take advantage of all the advanced search features.

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Constructor Summary

Constructors

Constructor and Description
BoxSearch(BoxAPIConnection api) Constructs a Search to be used by everything.

Method Summary

Modifier and Type	Method and Description
BoxAPIConnection	getAPI() Gets the API connection used by this resource.
PartialCollection<BoxItem.Info>	searchRange(long offset, long limit, BoxSearchParameters bsp) Searches all descendant folders using a given query and query parameters.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxSearch

public BoxSearch(BoxAPIConnection api)

Constructs a Search to be used by everything.

Parameters:

api - the API connection to be used by the search.

Method Detail

searchRange

public PartialCollection<BoxItem.Info> searchRange(long offset,
                                                   long limit,
                                                   BoxSearchParameters bsp)

Searches all descendant folders using a given query and query parameters.

Parameters:

offset - is the starting position.

limit - the number of search results CANNONT Exceed 1000.

bsp - containing query and advanced search capabilities.

Returns:

a PartialCollection containing the search results.

getAPI

public BoxAPIConnection getAPI()

Gets the API connection used by this resource.

Returns:

the API connection used by this resource.