MetadataTemplate (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - MetadataTemplate

All Implemented Interfaces:

Serializable
```
public class MetadataTemplate
extends SerializableObject
```
A template for metadata that can be applied to files and folders.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MetadataTemplate.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetadataTemplate.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`copyInstanceOnItemCopy` Whether or not to include the metadata when a file or folder is copied.
`protected String`	`displayName` The display name of the template.
`protected List<MetadataTemplateFieldsField>`	`fields` An ordered list of template fields which are part of the template.
`protected Boolean`	`hidden` Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.
`protected String`	`id` The ID of the metadata template.
`protected String`	`scope` The scope of the metadata template can either be `global` or `enterprise_*`.
`protected String`	`templateKey` A unique identifier for the template.
`protected EnumWrapper<MetadataTemplateTypeField>`	`type` The value will always be `metadata_template`.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected MetadataTemplate(MetadataTemplate.Builder builder)

MetadataTemplate(String id)

Constructors
Modifier	Constructor and Description
`protected`	`MetadataTemplate(MetadataTemplate.Builder builder)`
	`MetadataTemplate(String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Boolean`	`getCopyInstanceOnItemCopy()`
`String`	`getDisplayName()`
`List<MetadataTemplateFieldsField>`	`getFields()`
`Boolean`	`getHidden()`
`String`	`getId()`
`String`	`getScope()`
`String`	`getTemplateKey()`
`EnumWrapper<MetadataTemplateTypeField>`	`getType()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected final String id
```
    The ID of the metadata template.
  - type
```
protected EnumWrapper<MetadataTemplateTypeField> type
```
    The value will always be `metadata_template`.
  - scope
```
protected String scope
```
    The scope of the metadata template can either be `global` or `enterprise_*`. The `global` scope is used for templates that are available to any Box enterprise. The `enterprise_*` scope represents templates that have been created within a specific enterprise, where `*` will be the ID of that enterprise.
  - templateKey
```
protected String templateKey
```
    A unique identifier for the template. This identifier is unique across the `scope` of the enterprise to which the metadata template is being applied, yet is not necessarily unique across different enterprises.
  - displayName
```
protected String displayName
```
    The display name of the template. This can be seen in the Box web app and mobile apps.
  - hidden
```
protected Boolean hidden
```
    Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.
  - fields
```
protected List<MetadataTemplateFieldsField> fields
```
    An ordered list of template fields which are part of the template. Each field can be a regular text field, date field, number field, as well as a single or multi-select list.
  - copyInstanceOnItemCopy
```
protected Boolean copyInstanceOnItemCopy
```
    Whether or not to include the metadata when a file or folder is copied.
- Constructor Detail
  - MetadataTemplate
```
public MetadataTemplate(String id)
```
  - MetadataTemplate
```
protected MetadataTemplate(MetadataTemplate.Builder builder)
```
- Method Detail
  - getId
```
public String getId()
```
  - getType
```
public EnumWrapper<MetadataTemplateTypeField> getType()
```
  - getScope
```
public String getScope()
```
  - getTemplateKey
```
public String getTemplateKey()
```
  - getDisplayName
```
public String getDisplayName()
```
  - getHidden
```
public Boolean getHidden()
```
  - getFields
```
public List<MetadataTemplateFieldsField> getFields()
```
  - getCopyInstanceOnItemCopy
```
public Boolean getCopyInstanceOnItemCopy()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MetadataTemplate

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

id

type

scope

templateKey

displayName

hidden

fields

copyInstanceOnItemCopy

Constructor Detail

MetadataTemplate

MetadataTemplate

Method Detail

getId

getType

getScope

getTemplateKey

getDisplayName

getHidden

getFields

getCopyInstanceOnItemCopy

equals

hashCode

toString