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
class	MetadataTemplate.Field Class contains information about the metadata template field.

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

Methods

Modifier and Type	Method and Description
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.
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.
String	getScope() Gets the metadata template scope.
String	getTemplateKey() Gets the unique template key to identify the metadata template.

Methods inherited from class BoxJSONObject

clearPendingChanges, getPendingChanges

Methods inherited from class Object

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

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

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.

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.

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.