MetadataTemplateFieldsField (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - MetadataTemplateFieldsField

All Implemented Interfaces:: Serializable

public class MetadataTemplateFieldsField
extends SerializableObject

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MetadataTemplateFieldsField.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description` A description of the field.
`protected String`	`displayName` The display name of the field as it is shown to the user in the web and mobile apps.
`protected Boolean`	`hidden` Whether this field is hidden in the UI for the user and can only be set through the API instead.
`protected String`	`id` The unique ID of the metadata template field.
`protected String`	`key` A unique identifier for the field.
`protected String`	`namespace` The namespace of the metadata taxonomy to use for this taxonomy field.
`protected List<MetadataTemplateFieldsOptionsField>`	`options` A list of options for this field.
`protected MetadataTemplateFieldsOptionsRulesField`	`optionsRules` An object defining additional rules for the options of the taxonomy field.
`protected String`	`taxonomyId` The unique ID of the metadata taxonomy to use for this taxonomy field.
`protected String`	`taxonomyKey` The unique key of the metadata taxonomy to use for this taxonomy field.
`protected EnumWrapper<MetadataTemplateFieldsTypeField>`	`type` The type of field.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MetadataTemplateFieldsField(EnumWrapper<MetadataTemplateFieldsTypeField> type, String key, String displayName)`
`protected`	`MetadataTemplateFieldsField(MetadataTemplateFieldsField.Builder builder)`
	`MetadataTemplateFieldsField(MetadataTemplateFieldsTypeField type, String key, String displayName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getDescription()`
`String`	`getDisplayName()`
`Boolean`	`getHidden()`
`String`	`getId()`
`String`	`getKey()`
`String`	`getNamespace()`
`List<MetadataTemplateFieldsOptionsField>`	`getOptions()`
`MetadataTemplateFieldsOptionsRulesField`	`getOptionsRules()`
`String`	`getTaxonomyId()`
`String`	`getTaxonomyKey()`
`EnumWrapper<MetadataTemplateFieldsTypeField>`	`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
  - type
```
protected final EnumWrapper<MetadataTemplateFieldsTypeField> type
```
    The type of field. The basic fields are a `string` field for text, a `float` field for numbers, and a `date` fields to present the user with a date-time picker.
    Additionally, metadata templates support an `enum` field for a basic list of items, and `multiSelect` field for a similar list of items where the user can select more than one value.
    Metadata taxonomies are also supported as a `taxonomy` field type with a specific set of additional properties, which describe its structure.
    **Note**: The `integer` value is deprecated. It is still present in the response, but cannot be used in the POST request.
  - key
```
protected final String key
```
    A unique identifier for the field. The identifier must be unique within the template to which it belongs.
  - displayName
```
protected final String displayName
```
    The display name of the field as it is shown to the user in the web and mobile apps.
  - description
```
protected String description
```
    A description of the field. This is not shown to the user.
  - hidden
```
protected Boolean hidden
```
    Whether this field is hidden in the UI for the user and can only be set through the API instead.
  - options
```
protected List<MetadataTemplateFieldsOptionsField> options
```
    A list of options for this field. This is used in combination with the `enum` and `multiSelect` field types.
  - taxonomyKey
```
protected String taxonomyKey
```
    The unique key of the metadata taxonomy to use for this taxonomy field. This property is required when the field `type` is set to `taxonomy`.
  - taxonomyId
```
protected String taxonomyId
```
    The unique ID of the metadata taxonomy to use for this taxonomy field. This property is required when the field `type` is set to `taxonomy`.
  - namespace
```
protected String namespace
```
    The namespace of the metadata taxonomy to use for this taxonomy field. This property is required when the field `type` is set to `taxonomy`.
  - optionsRules
```
protected MetadataTemplateFieldsOptionsRulesField optionsRules
```
    An object defining additional rules for the options of the taxonomy field. This property is required when the field `type` is set to `taxonomy`.
  - id
```
protected String id
```
    The unique ID of the metadata template field.
- Constructor Detail
  - MetadataTemplateFieldsField
```
public MetadataTemplateFieldsField(MetadataTemplateFieldsTypeField type,
                                   String key,
                                   String displayName)
```
  - MetadataTemplateFieldsField
```
public MetadataTemplateFieldsField(EnumWrapper<MetadataTemplateFieldsTypeField> type,
                                   String key,
                                   String displayName)
```
  - MetadataTemplateFieldsField
```
protected MetadataTemplateFieldsField(MetadataTemplateFieldsField.Builder builder)
```
- Method Detail
  - getType
```
public EnumWrapper<MetadataTemplateFieldsTypeField> getType()
```
  - getKey
```
public String getKey()
```
  - getDisplayName
```
public String getDisplayName()
```
  - getDescription
```
public String getDescription()
```
  - getHidden
```
public Boolean getHidden()
```
  - getOptions
```
public List<MetadataTemplateFieldsOptionsField> getOptions()
```
  - getTaxonomyKey
```
public String getTaxonomyKey()
```
  - getTaxonomyId
```
public String getTaxonomyId()
```
  - getNamespace
```
public String getNamespace()
```
  - getOptionsRules
```
public MetadataTemplateFieldsOptionsRulesField getOptionsRules()
```
  - getId
```
public String getId()
```
  - 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 MetadataTemplateFieldsField

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

type

key

displayName

description

hidden

options

taxonomyKey

taxonomyId

namespace

optionsRules

id

Constructor Detail

MetadataTemplateFieldsField

MetadataTemplateFieldsField

MetadataTemplateFieldsField

Method Detail

getType

getKey

getDisplayName

getDescription

getHidden

getOptions

getTaxonomyKey

getTaxonomyId

getNamespace

getOptionsRules

getId

equals

hashCode

toString