com.box.sdkgen.managers.metadatatemplates

Class CreateMetadataTemplateRequestBodyFieldsField

Object

NullableFieldTracker

SerializableObject

CreateMetadataTemplateRequestBodyFieldsField

All Implemented Interfaces:

Serializable

public class CreateMetadataTemplateRequestBodyFieldsField
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateMetadataTemplateRequestBodyFieldsField.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	key A unique identifier for the field.
protected String	namespace The namespace of the metadata taxonomy to use for this taxonomy field.
protected List<CreateMetadataTemplateRequestBodyFieldsOptionsField>	options A list of options for this field.
protected CreateMetadataTemplateRequestBodyFieldsOptionsRulesField	optionsRules An object defining additional rules for the options of the taxonomy field.
protected String	taxonomyKey The unique key of the metadata taxonomy to use for this taxonomy field.
protected EnumWrapper<CreateMetadataTemplateRequestBodyFieldsTypeField>	type The type of field.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateMetadataTemplateRequestBodyFieldsField(CreateMetadataTemplateRequestBodyFieldsField.Builder builder)
	CreateMetadataTemplateRequestBodyFieldsField(CreateMetadataTemplateRequestBodyFieldsTypeField type, String key, String displayName)
	CreateMetadataTemplateRequestBodyFieldsField(EnumWrapper<CreateMetadataTemplateRequestBodyFieldsTypeField> type, String key, String displayName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
String	getDisplayName()
Boolean	getHidden()
String	getKey()
String	getNamespace()
List<CreateMetadataTemplateRequestBodyFieldsOptionsField>	getOptions()
CreateMetadataTemplateRequestBodyFieldsOptionsRulesField	getOptionsRules()
String	getTaxonomyKey()
EnumWrapper<CreateMetadataTemplateRequestBodyFieldsTypeField>	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<CreateMetadataTemplateRequestBodyFieldsTypeField> type

The type of field. The basic fields are a `string` field for text, a `float` field for numbers, and a `date` field 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.

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<CreateMetadataTemplateRequestBodyFieldsOptionsField> 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`.

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 CreateMetadataTemplateRequestBodyFieldsOptionsRulesField 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`.

Constructor Detail

CreateMetadataTemplateRequestBodyFieldsField

public CreateMetadataTemplateRequestBodyFieldsField(CreateMetadataTemplateRequestBodyFieldsTypeField type,
                                                    String key,
                                                    String displayName)

CreateMetadataTemplateRequestBodyFieldsField

public CreateMetadataTemplateRequestBodyFieldsField(EnumWrapper<CreateMetadataTemplateRequestBodyFieldsTypeField> type,
                                                    String key,
                                                    String displayName)

CreateMetadataTemplateRequestBodyFieldsField

protected CreateMetadataTemplateRequestBodyFieldsField(CreateMetadataTemplateRequestBodyFieldsField.Builder builder)

Method Detail

getType

public EnumWrapper<CreateMetadataTemplateRequestBodyFieldsTypeField> getType()

getKey

public String getKey()

getDisplayName

public String getDisplayName()

getDescription

public String getDescription()

getHidden

public Boolean getHidden()

getOptions

public List<CreateMetadataTemplateRequestBodyFieldsOptionsField> getOptions()

getTaxonomyKey

public String getTaxonomyKey()

getNamespace

public String getNamespace()

getOptionsRules

public CreateMetadataTemplateRequestBodyFieldsOptionsRulesField getOptionsRules()

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