com.box.sdk

Class MetadataQuery

Object

MetadataQuery

public class MetadataQuery
extends Object

Represents Metadata Query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataQuery.OrderBy

Constructor Summary

Constructors

Constructor and Description
MetadataQuery(String from) Creates Metadata Query
MetadataQuery(String from, int limit) Creates Metadata Query

Method Summary

Modifier and Type	Method and Description
MetadataQuery	addParameter(String name, boolean value) Adds parameter to query
MetadataQuery	addParameter(String name, double value) Adds parameter to query
MetadataQuery	addParameter(String name, float value) Adds parameter to query
MetadataQuery	addParameter(String name, int value) Adds parameter to query
MetadataQuery	addParameter(String name, JsonValue value) Adds parameter to query
MetadataQuery	addParameter(String name, long value) Adds parameter to query
MetadataQuery	addParameter(String name, String value) Adds parameter to query
MetadataQuery	setAncestorFolderId(String ancestorFolderId) Sets the folder_id to which to restrain the query.
MetadataQuery	setFields(String... fields) The fields to retrieve.
MetadataQuery	setMarker(String marker) The marker to use for requesting the next page
MetadataQuery	setOrderBy(MetadataQuery.OrderBy... fields) The field_key(s) to order on and the corresponding direction(s)
MetadataQuery	setQuery(String query) The logical expression of the query

Methods inherited from class Object

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

Constructor Detail

MetadataQuery

public MetadataQuery(String from,
                     int limit)

Creates Metadata Query

Parameters:

from - The template used in the query. Must be in the form scope_enterpriseID.templateKey

limit - Max results to return for a single request (0-100 inclusive)

MetadataQuery

public MetadataQuery(String from)

Creates Metadata Query

Parameters:

from - The template used in the query. Must be in the form scope.templateKey

Method Detail

setQuery

public MetadataQuery setQuery(String query)

The logical expression of the query

Parameters:

query - Query string

Returns:

Returns current MetadataQuery object

setAncestorFolderId

public MetadataQuery setAncestorFolderId(String ancestorFolderId)

Sets the folder_id to which to restrain the query. If not set query starts at root level.

Parameters:

ancestorFolderId - The folder id

Returns:

Returns current MetadataQuery object

setMarker

public MetadataQuery setMarker(String marker)

The marker to use for requesting the next page

Parameters:

marker - Marker string.

Returns:

Returns current MetadataQuery object

setOrderBy

public MetadataQuery setOrderBy(MetadataQuery.OrderBy... fields)

The field_key(s) to order on and the corresponding direction(s)

Parameters:

fields - Fields with sort order

Returns:

Returns current MetadataQuery object

setFields

public MetadataQuery setFields(String... fields)

The fields to retrieve.

Parameters:

fields - Field names

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  String value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  int value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  boolean value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  float value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  long value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  double value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object

addParameter

public MetadataQuery addParameter(String name,
                                  JsonValue value)

Adds parameter to query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Returns current MetadataQuery object