com.box.sdk

Class BoxSearchParameters

Object

BoxSearchParameters

public class BoxSearchParameters
extends Object

Used to Setup Box Search Parameters

Advanced Search support here allows a number of parameters be specified to take full advantage of box search capabilities. Query parameter is required in all cases except when Metadata templates searching is being used.

Constructor Summary

Constructors

Constructor and Description
BoxSearchParameters() Creates a Box Search Parameters Objects without query set, specific for Metadata Only Searches.
BoxSearchParameters(String query) Creates a Box Search Parameters Objects with a query initiated.

Method Summary

Modifier and Type	Method and Description
boolean	clearParameters() Clears the Parameters before performing a new search.
List<String>	getAncestorFolderIds() Return the list of folder ids that is currently being used as applied filter.
List<String>	getContentTypes() Return content types that or being applied as a filter (name,description,tags,file_content).
DateRange	getCreatedRange() Get the DateRange filter to specify the when a file was created.
DateRange	getDeletedRange() Limits the search results to items that were deleted within the given date range.
List<String>	getDeleterUserIds() Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs.
String	getDirection() Retrieves the sort direction for Box Search results.
List<String>	getFields() Get the existing fields that are used for the search criteria.
List<String>	getFileExtensions() Get file extension filter (jpg,docx).
BoxMetadataFilter	getMetadataFilter() Retrieve the existing BoxMetaDataFilter.
List<String>	getOwnerUserIds() Return the list of owner id's that are being applied as a search filter on the results.
String	getQuery() Get existing query String that is being used.
QueryStringBuilder	getQueryParameters() Get the Query Paramaters to be used for search request.
String	getScope() Get the scope on which you want to search, ["enterprise","scope"].
SizeRange	getSizeRange() Return the size range that is being used as a filter.
String	getSort() Retrieve the sort field for Box Search.
String	getTrashContent() Return the specified trash search preference.
String	getType() Return the type you want to return in your search.
DateRange	getUpdatedRange() Get the DateRange filter to specify the when a file was updated.
void	setAncestorFolderIds(List<String> ancestorFolderIds) Set the list of folder id's to be applied as a filter on the search filters.
void	setContentTypes(List<String> contentTypes) Set list of content types that will be used as a filters.
void	setCreatedRange(DateRange createdRange) Set the from DateRange filter to specify when a file was created.
void	setDeletedRange(DateRange deletedRange) Limits the search results to items that were deleted within the given date range.
void	setDeleterUserIds(List<String> deleterUserIds) Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs.
void	setDirection(String direction) Set the direction of the sort for the Box Search results.
void	setFields(List<String> fields) Set the existing fields that are used for the search criteria.
void	setFileExtensions(List<String> fileExtensions) Set file extension by providing a list of strings [jpg,docx].
void	setMetadataFilter(BoxMetadataFilter metadataFilter) Set the current list of Metadata Filters.
void	setOwnerUserIds(List<String> ownerUserIds) Set the owner id's to be applied as a filter to restrict the results on specific file owners.
void	setQuery(String query) Set query string for that will be used to search.
void	setScope(String scope) Set the scope for how you want to search, ["enterprise","scope"].
void	setSizeRange(SizeRange sizeRange) Set the file size range for lower and upper bounds Bytes.
void	setSort(String sortBy) Set the sort field for Box Search.
void	setTrashContent(String trashContent) Set trash filter.
void	setType(String type) Set the type you want to search for can be file, folder, or web_link.
void	setUpdatedRange(DateRange updatedRange) Set the from DateRange filter to specify when a file was updated.

Methods inherited from class Object

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

Constructor Detail

BoxSearchParameters

public BoxSearchParameters()

Creates a Box Search Parameters Objects without query set, specific for Metadata Only Searches.

BoxSearchParameters

public BoxSearchParameters(String query)

Creates a Box Search Parameters Objects with a query initiated.

Parameters:

query - parameter.

Method Detail

clearParameters

public boolean clearParameters()

Clears the Parameters before performing a new search.

Returns:

this.true;

getQuery

public String getQuery()

Get existing query String that is being used.

Returns:

this.query string.

setQuery

public void setQuery(String query)

Set query string for that will be used to search.

Parameters:

query - is a String value.

getFields

public List<String> getFields()

Get the existing fields that are used for the search criteria.

Returns:

this.List of fields.

setFields

public void setFields(List<String> fields)

Set the existing fields that are used for the search criteria.

Parameters:

fields - specify what fields to be returned.

getScope

public String getScope()

Get the scope on which you want to search, ["enterprise","scope"].

Returns:

this.current scope that is set.

setScope

public void setScope(String scope)

Set the scope for how you want to search, ["enterprise","scope"].

Parameters:

scope - set scope you want to search.

getFileExtensions

public List<String> getFileExtensions()

Get file extension filter (jpg,docx).

Returns:

this.list of extensions.

setFileExtensions

public void setFileExtensions(List<String> fileExtensions)

Set file extension by providing a list of strings [jpg,docx].

Parameters:

fileExtensions - applied as a filter for extensions.

getCreatedRange

public DateRange getCreatedRange()

Get the DateRange filter to specify the when a file was created.

Returns:

this.createdRange DateRange.

setCreatedRange

public void setCreatedRange(DateRange createdRange)

Set the from DateRange filter to specify when a file was created.

Parameters:

createdRange - a start and end date on which a file was created.

getUpdatedRange

public DateRange getUpdatedRange()

Get the DateRange filter to specify the when a file was updated.

Returns:

this.updatedRange DateRange.

setUpdatedRange

public void setUpdatedRange(DateRange updatedRange)

Set the from DateRange filter to specify when a file was updated.

Parameters:

updatedRange - a start and end date on which a file was updated.

getSizeRange

public SizeRange getSizeRange()

Return the size range that is being used as a filter.

Returns:

this.sizeRange.

setSizeRange

public void setSizeRange(SizeRange sizeRange)

Set the file size range for lower and upper bounds Bytes.

Parameters:

sizeRange - a size filter.

getOwnerUserIds

public List<String> getOwnerUserIds()

Return the list of owner id's that are being applied as a search filter on the results.

Returns:

ownerUserIds.

setOwnerUserIds

public void setOwnerUserIds(List<String> ownerUserIds)

Set the owner id's to be applied as a filter to restrict the results on specific file owners.

Parameters:

ownerUserIds - applied ownerId's.

getAncestorFolderIds

public List<String> getAncestorFolderIds()

Return the list of folder ids that is currently being used as applied filter.

Returns:

ancestorFolderIds.

setAncestorFolderIds

public void setAncestorFolderIds(List<String> ancestorFolderIds)

Set the list of folder id's to be applied as a filter on the search filters.

Parameters:

ancestorFolderIds - a list of folder ids that will contain results to specific folders.

getContentTypes

public List<String> getContentTypes()

Return content types that or being applied as a filter (name,description,tags,file_content).

Returns:

contentTypes.

setContentTypes

public void setContentTypes(List<String> contentTypes)

Set list of content types that will be used as a filters.

Parameters:

contentTypes - a list of content types such as (name,description,tags,file_content).

getType

public String getType()

Return the type you want to return in your search.

Returns:

String type.

setType

public void setType(String type)

Set the type you want to search for can be file, folder, or web_link.

Parameters:

type - can be file, folder, or web_link.

getTrashContent

public String getTrashContent()

Return the specified trash search preference.

Returns:

String trashContent.

setTrashContent

public void setTrashContent(String trashContent)

Set trash filter. Can be trashed_only or non_trashed_only, without this parameter default to non_trashed_only.

Parameters:

trashContent - Can be trashed_only or non_trashed_only.

getMetadataFilter

public BoxMetadataFilter getMetadataFilter()

Retrieve the existing BoxMetaDataFilter.

Returns:

this.BoxMetaDataFilter

setMetadataFilter

public void setMetadataFilter(BoxMetadataFilter metadataFilter)

Set the current list of Metadata Filters.

Parameters:

metadataFilter - a list of the current metadata filters.

getSort

public String getSort()

Retrieve the sort field for Box Search.

Returns:

String identifier for Sort.

setSort

public void setSort(String sortBy)

Set the sort field for Box Search.

Parameters:

sortBy - the field to sort the Box Search results by.

getDirection

public String getDirection()

Retrieves the sort direction for Box Search results.

Returns:

The direction of the Box Search sort.

setDirection

public void setDirection(String direction)

Set the direction of the sort for the Box Search results.

Parameters:

direction - can be DESC or ASC.

getDeleterUserIds

public List<String> getDeleterUserIds()

Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The trash_content parameter needs to be set to trashed_only.

Returns:

deleterUserIds.

setDeleterUserIds

public void setDeleterUserIds(List<String> deleterUserIds)

Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The trash_content parameter needs to be set to trashed_only.

Parameters:

deleterUserIds - a list of user ids.

getDeletedRange

public DateRange getDeletedRange()

Limits the search results to items that were deleted within the given date range. The trash_content parameter needs to be set to trashed_only.

Returns:

deletedRange.

setDeletedRange

public void setDeletedRange(DateRange deletedRange)

Limits the search results to items that were deleted within the given date range. The trash_content parameter needs to be set to trashed_only.

Parameters:

deletedRange - a date range.

getQueryParameters

public QueryStringBuilder getQueryParameters()

Get the Query Paramaters to be used for search request.

Returns:

this.QueryStringBuilder.