com.box.sdk

Class MetadataTemplate

Object

BoxJSONObject

MetadataTemplate

public class MetadataTemplate
extends BoxJSONObject

The MetadataTemplate class represents the Box metadata template object. Templates allow the metadata service to provide a multitude of services, such as pre-defining sets of key:value pairs or schema enforcement on specific fields.

See Also:

Box metadata templates

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataTemplate.Field Class contains information about the metadata template field.
static class	MetadataTemplate.FieldOperation Posssible operations that can be performed in a Metadata template.
static class	MetadataTemplate.Operation Possible template operations.
static class	MetadataTemplate.Option Class contains information about the metadata template option.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ENTERPRISE_METADATA_URL_TEMPLATE
static URLTemplate	METADATA_TEMPLATE_BY_ID_URL_TEMPLATE
static URLTemplate	METADATA_TEMPLATE_SCHEMA_URL_TEMPLATE
static URLTemplate	METADATA_TEMPLATE_URL_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
MetadataTemplate() Constructs an empty metadata template.
MetadataTemplate(String json) Constructs a metadata template from a JSON string.

Method Summary

Modifier and Type	Method and Description
static MetadataTemplate	createMetadataTemplate(BoxAPIConnection api, String scope, String templateKey, String displayName, boolean hidden, List<MetadataTemplate.Field> fields) Creates new metadata template.
static void	deleteMetadataTemplate(BoxAPIConnection api, String scope, String template) Deletes the schema of an existing metadata template.
static BoxResourceIterable<BoxMetadataQueryItem>	executeMetadataQuery(BoxAPIConnection api, String from, String ancestorFolderId) Executes a metadata query.
static BoxResourceIterable<BoxMetadataQueryItem>	executeMetadataQuery(BoxAPIConnection api, String from, String query, JsonObject queryParameters, String ancestorFolderId) Executes a metadata query.
static BoxResourceIterable<BoxMetadataQueryItem>	executeMetadataQuery(BoxAPIConnection api, String from, String query, JsonObject queryParameters, String ancestorFolderId, String indexName, JsonArray orderBy) Executes a metadata query.
static BoxResourceIterable<BoxMetadataQueryItem>	executeMetadataQuery(BoxAPIConnection api, String from, String query, JsonObject queryParameters, String ancestorFolderId, String indexName, JsonArray orderBy, int limit, String marker) Executes a metadata query.
String	getDisplayName() Gets the displayed metadata template name.
static Iterable<MetadataTemplate>	getEnterpriseMetadataTemplates(BoxAPIConnection api, String... fields) Returns all metadata templates within a user's enterprise.
static Iterable<MetadataTemplate>	getEnterpriseMetadataTemplates(String scope, BoxAPIConnection api, String... fields) Returns all metadata templates within a user's scope.
static Iterable<MetadataTemplate>	getEnterpriseMetadataTemplates(String scope, int limit, BoxAPIConnection api, String... fields) Returns all metadata templates within a user's scope.
List<MetadataTemplate.Field>	getFields() Gets the iterable with all fields the metadata template contains.
String	getID() Gets the ID of the template.
Boolean	getIsHidden() Gets is the metadata template hidden.
static MetadataTemplate	getMetadataTemplate(BoxAPIConnection api) Gets the metadata template of properties.
static MetadataTemplate	getMetadataTemplate(BoxAPIConnection api, String templateName) Gets the metadata template of specified template type.
static MetadataTemplate	getMetadataTemplate(BoxAPIConnection api, String templateName, String scope, String... fields) Gets the metadata template of specified template type.
static MetadataTemplate	getMetadataTemplateByID(BoxAPIConnection api, String templateID) Geta the specified metadata template by its ID.
String	getScope() Gets the metadata template scope.
String	getTemplateKey() Gets the unique template key to identify the metadata template.
static MetadataTemplate	updateMetadataTemplate(BoxAPIConnection api, String scope, String template, List<MetadataTemplate.FieldOperation> fieldOperations) Updates the schema of an existing metadata template.

Methods inherited from class BoxJSONObject

clearPendingChanges, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Field Detail

METADATA_TEMPLATE_URL_TEMPLATE

public static final URLTemplate METADATA_TEMPLATE_URL_TEMPLATE

See Also:

getMetadataTemplate(BoxAPIConnection)

METADATA_TEMPLATE_BY_ID_URL_TEMPLATE

public static final URLTemplate METADATA_TEMPLATE_BY_ID_URL_TEMPLATE

See Also:

getMetadataTemplateByID(BoxAPIConnection, String)

METADATA_TEMPLATE_SCHEMA_URL_TEMPLATE

public static final URLTemplate METADATA_TEMPLATE_SCHEMA_URL_TEMPLATE

See Also:

createMetadataTemplate(BoxAPIConnection, String, String, String, boolean, List)

ENTERPRISE_METADATA_URL_TEMPLATE

public static final URLTemplate ENTERPRISE_METADATA_URL_TEMPLATE

See Also:

getEnterpriseMetadataTemplates(String, int, BoxAPIConnection, String...)

Constructor Detail

MetadataTemplate

public MetadataTemplate()

Constructs an empty metadata template.

MetadataTemplate

public MetadataTemplate(String json)

Constructs a metadata template from a JSON string.

Parameters:

json - the json encoded metadate template.

Method Detail

getID

public String getID()

Gets the ID of the template.

Returns:

the template ID.

getTemplateKey

public String getTemplateKey()

Gets the unique template key to identify the metadata template.

Returns:

the unique template key to identify the metadata template.

getScope

public String getScope()

Gets the metadata template scope.

Returns:

the metadata template scope.

getDisplayName

public String getDisplayName()

Gets the displayed metadata template name.

Returns:

the displayed metadata template name.

getIsHidden

public Boolean getIsHidden()

Gets is the metadata template hidden.

Returns:

is the metadata template hidden.

getFields

public List<MetadataTemplate.Field> getFields()

Gets the iterable with all fields the metadata template contains.

Returns:

the iterable with all fields the metadata template contains.

createMetadataTemplate

public static MetadataTemplate createMetadataTemplate(BoxAPIConnection api,
                                                      String scope,
                                                      String templateKey,
                                                      String displayName,
                                                      boolean hidden,
                                                      List<MetadataTemplate.Field> fields)

Creates new metadata template.

Parameters:

api - the API connection to be used.

scope - the scope of the object.

templateKey - a unique identifier for the template.

displayName - the display name of the field.

hidden - whether this template is hidden in the UI.

fields - the ordered set of fields for the template

Returns:

the metadata template returned from the server.

updateMetadataTemplate

public static MetadataTemplate updateMetadataTemplate(BoxAPIConnection api,
                                                      String scope,
                                                      String template,
                                                      List<MetadataTemplate.FieldOperation> fieldOperations)

Updates the schema of an existing metadata template.

Parameters:

api - the API connection to be used

scope - the scope of the object

template - Unique identifier of the template

fieldOperations - the fields that needs to be updated / added in the template

Returns:

the updated metadata template

deleteMetadataTemplate

public static void deleteMetadataTemplate(BoxAPIConnection api,
                                          String scope,
                                          String template)

Deletes the schema of an existing metadata template.

Parameters:

api - the API connection to be used

scope - the scope of the object

template - Unique identifier of the template

executeMetadataQuery

public static BoxResourceIterable<BoxMetadataQueryItem> executeMetadataQuery(BoxAPIConnection api,
                                                                             String from,
                                                                             String ancestorFolderId)

Executes a metadata query.

Parameters:

api - The API connection to be used

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

ancestorFolderId - The folder_id to which to restrain the query

Returns:

An iterable of BoxMetadataQueryItem search results

executeMetadataQuery

public static BoxResourceIterable<BoxMetadataQueryItem> executeMetadataQuery(BoxAPIConnection api,
                                                                             String from,
                                                                             String query,
                                                                             JsonObject queryParameters,
                                                                             String ancestorFolderId)

Executes a metadata query.

Parameters:

api - The API connection to be used

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

query - The logical expression of the query

queryParameters - Required if query present. The arguments for the query

ancestorFolderId - The folder_id to which to restrain the query

Returns:

An iterable of BoxMetadataQueryItem search results

executeMetadataQuery

public static BoxResourceIterable<BoxMetadataQueryItem> executeMetadataQuery(BoxAPIConnection api,
                                                                             String from,
                                                                             String query,
                                                                             JsonObject queryParameters,
                                                                             String ancestorFolderId,
                                                                             String indexName,
                                                                             JsonArray orderBy)

Executes a metadata query.

Parameters:

api - The API connection to be used

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

query - The logical expression of the query

queryParameters - Required if query present. The arguments for the query

ancestorFolderId - The folder_id to which to restrain the query

indexName - The name of the Index to use

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

Returns:

An iterable of BoxMetadataQueryItem search results

executeMetadataQuery

public static BoxResourceIterable<BoxMetadataQueryItem> executeMetadataQuery(BoxAPIConnection api,
                                                                             String from,
                                                                             String query,
                                                                             JsonObject queryParameters,
                                                                             String ancestorFolderId,
                                                                             String indexName,
                                                                             JsonArray orderBy,
                                                                             int limit,
                                                                             String marker)

Executes a metadata query.

Parameters:

api - The API connection to be used

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

query - The logical expression of the query

queryParameters - Required if query present. The arguments for the query

ancestorFolderId - The folder_id to which to restrain the query

indexName - The name of the Index to use

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

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

marker - The marker to use for requesting the next page

Returns:

An iterable of BoxMetadataQueryItem search results

getMetadataTemplate

public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api)

Gets the metadata template of properties.

Parameters:

api - the API connection to be used.

Returns:

the metadata template returned from the server.

getMetadataTemplate

public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api,
                                                   String templateName)

Gets the metadata template of specified template type.

Parameters:

api - the API connection to be used.

templateName - the metadata template type name.

Returns:

the metadata template returned from the server.

getMetadataTemplate

public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api,
                                                   String templateName,
                                                   String scope,
                                                   String... fields)

Gets the metadata template of specified template type.

Parameters:

api - the API connection to be used.

templateName - the metadata template type name.

scope - the metadata template scope (global or enterprise).

fields - the fields to retrieve.

Returns:

the metadata template returned from the server.

getMetadataTemplateByID

public static MetadataTemplate getMetadataTemplateByID(BoxAPIConnection api,
                                                       String templateID)

Geta the specified metadata template by its ID.

Parameters:

api - the API connection to be used.

templateID - the ID of the template to get.

Returns:

the metadata template object.

getEnterpriseMetadataTemplates

public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(BoxAPIConnection api,
                                                                        String... fields)

Returns all metadata templates within a user's enterprise.

Parameters:

api - the API connection to be used.

fields - the fields to retrieve.

Returns:

the metadata template returned from the server.

getEnterpriseMetadataTemplates

public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(String scope,
                                                                        BoxAPIConnection api,
                                                                        String... fields)

Returns all metadata templates within a user's scope. Currently only the enterprise scope is supported.

Parameters:

scope - the scope of the metadata templates.

api - the API connection to be used.

fields - the fields to retrieve.

Returns:

the metadata template returned from the server.

getEnterpriseMetadataTemplates

public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(String scope,
                                                                        int limit,
                                                                        BoxAPIConnection api,
                                                                        String... fields)

Returns all metadata templates within a user's scope. Currently only the enterprise scope is supported.

Parameters:

scope - the scope of the metadata templates.

limit - maximum number of entries per response.

api - the API connection to be used.

fields - the fields to retrieve.

Returns:

the metadata template returned from the server.