com.box.androidsdk.content.requests

Class BoxRequestsSearch.Search

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestItem<BoxIteratorItems,BoxRequestsSearch.Search>

com.box.androidsdk.content.requests.BoxRequestsSearch.Search

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorItems>, java.io.Serializable

Enclosing class:

BoxRequestsSearch

public static class BoxRequestsSearch.Search
extends BoxRequestItem<BoxIteratorItems,BoxRequestsSearch.Search>
implements BoxCacheableRequest<BoxIteratorItems>

Request for searching.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxRequestsSearch.Search.Scope

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods, BoxRequest.TLSSSLSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE_COMMENTS Only search in comments.
static java.lang.String	CONTENT_TYPE_DESCRIPTION Only search in descriptions.
static java.lang.String	CONTENT_TYPE_FILE_CONTENTS Only search in file contents.
static java.lang.String	CONTENT_TYPE_NAME Only search in names.
static java.lang.String	CONTENT_TYPE_TAGS Only search in tags.
protected static java.lang.String	FIELD_ANCESTOR_FOLDER_IDS Field for setting the ancestor folder ids.
protected static java.lang.String	FIELD_CONTENT_TYPES Field for setting the content types: name, description, file_content, comments, or tags.
protected static java.lang.String	FIELD_CREATED_AT_RANGE Field for setting the created at range.
protected static java.lang.String	FIELD_FILE_EXTENSIONS Field for setting the file extensions.
protected static java.lang.String	FIELD_LIMIT Field for setting number of search results to return (default=30, max =200)
protected static java.lang.String	FIELD_OFFSET The search result at which to start the response.
protected static java.lang.String	FIELD_OWNER_USER_IDS Field for setting the owner user ids.
protected static java.lang.String	FIELD_QUERY Field for setting the search query.
protected static java.lang.String	FIELD_SCOPE Field for setting the scope for admins only.
protected static java.lang.String	FIELD_SIZE_RANGE Field for setting the size range.
protected static java.lang.String	FIELD_TYPE Field for setting return type: file, folder, or web_link.
protected static java.lang.String	FIELD_UPDATED_AT_RANGE Field for setting the updated at range.

Fields inherited from class com.box.androidsdk.content.requests.BoxRequestItem

mHintHeader, mId, QUERY_FIELDS

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
Search(java.lang.String query, java.lang.String requestUrl, BoxSession session) Creates a search request with the default parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAncestorFolderIds()
java.lang.String[]	getContentTypes()
java.util.Date	getCreatedAtDateRangeFrom()
java.util.Date	getCreatedAtDateRangeTo()
java.lang.String[]	getFileExtensions()
java.util.Date	getLastUpdatedAtDateRangeFrom()
java.util.Date	getLastUpdatedAtDateRangeTo()
java.lang.Integer	getLimit()
java.lang.Integer	getOffset()
java.lang.String[]	getOwnerUserIds()
java.lang.String	getQuery()
java.lang.String	getScope()
java.lang.Long	getSizeRangeFrom()
java.lang.Long	getSizeRangeTo()
java.lang.String	getType()
BoxRequestsSearch.Search	limitAncestorFolderIds(java.lang.String[] folderIds) Limit searches to specific ancestor folders.
BoxRequestsSearch.Search	limitContentTypes(java.lang.String[] contentTypes) Limit search to certain content types.
BoxRequestsSearch.Search	limitCreationTime(java.util.Date fromDate, java.util.Date toDate) Limit the search to creation time between fromDate to toDate.
BoxRequestsSearch.Search	limitFileExtensions(java.lang.String[] extensions) limit file search to given file extensions.
BoxRequestsSearch.Search	limitLastUpdateTime(java.util.Date fromDate, java.util.Date toDate) Limit the search to last update time between fromDate to toDate.
BoxRequestsSearch.Search	limitOwnerUserIds(java.lang.String[] userIds) limit the search to items owned by given users.
BoxRequestsSearch.Search	limitSearchScope(BoxRequestsSearch.Search.Scope scope) limit search scope.
BoxRequestsSearch.Search	limitSizeRange(long minSize, long maxSize) Limit the search to file size greater than minSize in bytes and less than maxSize in bytes.
BoxRequestsSearch.Search	limitType(java.lang.String type) The type you want to return in your search.
BoxRequestsSearch.Search	limitValueForKey(java.lang.String key, java.lang.String value) Generic key and values used to limit search for
BoxIteratorItems	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsSearch.Search	setLimit(int limit) Sets the limit of items that should be returned
BoxRequestsSearch.Search	setOffset(int offset) Sets the offset of the items that should be returned
BoxFutureTask<BoxIteratorItems>	toTaskForCachedResult() Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequestItem

addRepresentationHintGroup, createHeaderMap, getId, onSendCompleted, setFields

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE_NAME

public static java.lang.String CONTENT_TYPE_NAME

Only search in names.

CONTENT_TYPE_DESCRIPTION

public static java.lang.String CONTENT_TYPE_DESCRIPTION

Only search in descriptions.

CONTENT_TYPE_COMMENTS

public static java.lang.String CONTENT_TYPE_COMMENTS

Only search in comments.

CONTENT_TYPE_FILE_CONTENTS

public static java.lang.String CONTENT_TYPE_FILE_CONTENTS

Only search in file contents.

CONTENT_TYPE_TAGS

public static java.lang.String CONTENT_TYPE_TAGS

Only search in tags.

FIELD_QUERY

protected static final java.lang.String FIELD_QUERY

Field for setting the search query.

See Also:

Constant Field Values

FIELD_SCOPE

protected static final java.lang.String FIELD_SCOPE

Field for setting the scope for admins only.

See Also:

Constant Field Values

FIELD_FILE_EXTENSIONS

protected static final java.lang.String FIELD_FILE_EXTENSIONS

Field for setting the file extensions.

See Also:

Constant Field Values

FIELD_CREATED_AT_RANGE

protected static final java.lang.String FIELD_CREATED_AT_RANGE

Field for setting the created at range.

See Also:

Constant Field Values

FIELD_UPDATED_AT_RANGE

protected static final java.lang.String FIELD_UPDATED_AT_RANGE

Field for setting the updated at range.

See Also:

Constant Field Values

FIELD_SIZE_RANGE

protected static final java.lang.String FIELD_SIZE_RANGE

Field for setting the size range.

See Also:

Constant Field Values

FIELD_OWNER_USER_IDS

protected static final java.lang.String FIELD_OWNER_USER_IDS

Field for setting the owner user ids.

See Also:

Constant Field Values

FIELD_ANCESTOR_FOLDER_IDS

protected static final java.lang.String FIELD_ANCESTOR_FOLDER_IDS

Field for setting the ancestor folder ids.

See Also:

Constant Field Values

FIELD_CONTENT_TYPES

protected static final java.lang.String FIELD_CONTENT_TYPES

Field for setting the content types: name, description, file_content, comments, or tags.

See Also:

Constant Field Values

FIELD_TYPE

protected static final java.lang.String FIELD_TYPE

Field for setting return type: file, folder, or web_link.

See Also:

Constant Field Values

FIELD_LIMIT

protected static final java.lang.String FIELD_LIMIT

Field for setting number of search results to return (default=30, max =200)

See Also:

Constant Field Values

FIELD_OFFSET

protected static final java.lang.String FIELD_OFFSET

The search result at which to start the response. (default=0)

See Also:

Constant Field Values

Constructor Detail

Search

public Search(java.lang.String query,
              java.lang.String requestUrl,
              BoxSession session)

Creates a search request with the default parameters.

Parameters:

query - query to search for.

requestUrl - URL of the search endpoint.

session - the authenticated session that will be used to make the request with

Method Detail

sendForCachedResult

public BoxIteratorItems sendForCachedResult()
                                     throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxIteratorItems>

Returns:

the cached results of the request

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig, or if there was another issue getting cached results.

toTaskForCachedResult

public BoxFutureTask<BoxIteratorItems> toTaskForCachedResult()
                                                      throws BoxException

Description copied from interface: BoxCacheableRequest

Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Specified by:

toTaskForCachedResult in interface BoxCacheableRequest<BoxIteratorItems>

Returns:

a task that will fetch the results from the cache

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig.

limitValueForKey

public BoxRequestsSearch.Search limitValueForKey(java.lang.String key,
                                                 java.lang.String value)

Generic key and values used to limit search for

Parameters:

key - key to limit search to.

value - value for key to limit search to.

Returns:

request with the updated values.

limitSearchScope

public BoxRequestsSearch.Search limitSearchScope(BoxRequestsSearch.Search.Scope scope)

limit search scope. Please check https://developers.box.com/docs/#search for details.

Parameters:

scope - scope to limit search to.

Returns:

request with the updated values.

limitFileExtensions

public BoxRequestsSearch.Search limitFileExtensions(java.lang.String[] extensions)

limit file search to given file extensions.

Parameters:

extensions - file extensions to limit search to.

Returns:

request with the updated values.

limitCreationTime

public BoxRequestsSearch.Search limitCreationTime(java.util.Date fromDate,
                                                  java.util.Date toDate)

Limit the search to creation time between fromDate to toDate.

Parameters:

fromDate - can use null if you don't want to restrict this.

toDate - can use null if you don't want to restrict this.

Returns:

request with the updated values.

limitLastUpdateTime

public BoxRequestsSearch.Search limitLastUpdateTime(java.util.Date fromDate,
                                                    java.util.Date toDate)

Limit the search to last update time between fromDate to toDate.

Parameters:

fromDate - can use null if you don't want to restrict this.

toDate - can use null if you don't want to restrict this.

Returns:

request with the updated values.

limitSizeRange

public BoxRequestsSearch.Search limitSizeRange(long minSize,
                                               long maxSize)

Limit the search to file size greater than minSize in bytes and less than maxSize in bytes.

Parameters:

minSize - the minimum size in bytes to limit search to.

maxSize - the maximum size in bytes to limit search to.

Returns:

request with the updated values.

limitOwnerUserIds

public BoxRequestsSearch.Search limitOwnerUserIds(java.lang.String[] userIds)

limit the search to items owned by given users.

Parameters:

userIds - user ids to limit search to.

Returns:

request with the updated values.

limitAncestorFolderIds

public BoxRequestsSearch.Search limitAncestorFolderIds(java.lang.String[] folderIds)

Limit searches to specific ancestor folders.

Parameters:

folderIds - folder ids to limit search to.

Returns:

request with the updated values.

limitContentTypes

public BoxRequestsSearch.Search limitContentTypes(java.lang.String[] contentTypes)

Limit search to certain content types. The allowed content type strings are defined as final static in this class. e.g. Search.CONTENT_TYPE_NAME, Search.CONTENT_TYPE_DESCRIPTION...

Parameters:

contentTypes - content types to limit search to.

Returns:

request with the updated values.

limitType

public BoxRequestsSearch.Search limitType(java.lang.String type)

The type you want to return in your search. Can be BoxFile.TYPE, BoxFolder.TYPE, BoxBookmark.TYPE.

Parameters:

type - the box content type to limit search to.

Returns:

request with the updated values.

setLimit

public BoxRequestsSearch.Search setLimit(int limit)

Sets the limit of items that should be returned

Parameters:

limit - limit of items to return

Returns:

the get folder items request

setOffset

public BoxRequestsSearch.Search setOffset(int offset)

Sets the offset of the items that should be returned

Parameters:

offset - offset of items to return

Returns:

the offset of the items to return

getLastUpdatedAtDateRangeFrom

public java.util.Date getLastUpdatedAtDateRangeFrom()

Returns:

the minimum last updated at date set in this request if this request was limited, null otherwise.

getLastUpdatedAtDateRangeTo

public java.util.Date getLastUpdatedAtDateRangeTo()

Returns:

the maximum last updated at date set in this request if this request was limited, null otherwise.

getCreatedAtDateRangeFrom

public java.util.Date getCreatedAtDateRangeFrom()

Returns:

the minimum created at date set in this request if this request was limited, null otherwise.

getCreatedAtDateRangeTo

public java.util.Date getCreatedAtDateRangeTo()

Returns:

the maximum created at date set in this request if this request was limited, null otherwise.

getSizeRangeFrom

public java.lang.Long getSizeRangeFrom()

Returns:

the minimum size set in this request if this request was limited, null otherwise.

getSizeRangeTo

public java.lang.Long getSizeRangeTo()

Returns:

the maximum size set in this request if this request was limited, null otherwise.

getOwnerUserIds

public java.lang.String[] getOwnerUserIds()

Returns:

the owner user ids this request is limited to.

getAncestorFolderIds

public java.lang.String[] getAncestorFolderIds()

Returns:

the ancestor folder ids this request is limited to.

getContentTypes

public java.lang.String[] getContentTypes()

Returns:

the content types this request is limited to.

getType

public java.lang.String getType()

Returns:

the type this search is limited to.

getLimit

public java.lang.Integer getLimit()

Returns:

the number of searches to return.

getOffset

public java.lang.Integer getOffset()

Returns:

the offset set for this search query.

getQuery

public java.lang.String getQuery()

Returns:

the query this request will search for.

getScope

public java.lang.String getScope()

Returns:

the search scope limitation of this request

getFileExtensions

public java.lang.String[] getFileExtensions()

Returns:

the file extensions this search is limited to separated by commas.