com.box.sdk

Class BoxMetadataFilter

Object

BoxMetadataFilter

public class BoxMetadataFilter
extends Object

BoxMetadataFilter is used to help organize the request for when making metadata filter request in conjuction with search. The translation will look something like this: [{"templateKey":"marketingCollateral", "scope":"enterprise", "filters":{"documentType": "datasheet"}}]

Constructor Summary

Constructors

Constructor and Description
BoxMetadataFilter() Constructor for BoxMetadataFilter that initizlizes the JSON Object.

Method Summary

Modifier and Type	Method and Description
void	addDateRangeFilter(String key, DateRange dateRange) Set a filter to the filterList, example: key=documentNumber, gt : "", lt : "".
void	addFilter(String key, String value) Set a filter to the filterList, example: key=documentType, value=special.
void	addNumberRangeFilter(String key, SizeRange sizeRange) Set a NumberRanger filter to the filter numbers, example: key=documentNumber, lt : 20, gt : 5.
JsonObject	getFiltersList() return this.a list of the current filters that are being set.
String	getScope() return this.the current scope being used.
String	getTemplateKey() Returns the template key that currently set.
void	setScope(String scope) Set the scope for the key, currently only "enterprise" and "global" are allowed.
void	setTemplateKey(String templateKey) Set the current template key for the search filter.

Methods inherited from class Object

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

Constructor Detail

BoxMetadataFilter

public BoxMetadataFilter()

Constructor for BoxMetadataFilter that initizlizes the JSON Object.

Method Detail

getTemplateKey

public String getTemplateKey()

Returns the template key that currently set.

Returns:

this.String template key.

setTemplateKey

public void setTemplateKey(String templateKey)

Set the current template key for the search filter.

Parameters:

templateKey - must be a metadata template key.

getFiltersList

public JsonObject getFiltersList()

return this.a list of the current filters that are being set.

Returns:

this.JsonObject filterList.

addFilter

public void addFilter(String key,
                      String value)

Set a filter to the filterList, example: key=documentType, value=special.

Parameters:

key - the key that the filter should be looking for.

value - the specific value that corresponds to the key.

addNumberRangeFilter

public void addNumberRangeFilter(String key,
                                 SizeRange sizeRange)

Set a NumberRanger filter to the filter numbers, example: key=documentNumber, lt : 20, gt : 5.

Parameters:

key - the key that the filter should be looking for.

sizeRange - the specific value that corresponds to the key.

addDateRangeFilter

public void addDateRangeFilter(String key,
                               DateRange dateRange)

Set a filter to the filterList, example: key=documentNumber, gt : "", lt : "".

Parameters:

key - the key that the filter should be looking for.

dateRange - the date range that is start and end dates

getScope

public String getScope()

return this.the current scope being used.

Returns:

this.String scope.

setScope

public void setScope(String scope)

Set the scope for the key, currently only "enterprise" and "global" are allowed.

Parameters:

scope - the scope on which to find the template.