com.box.sdk

Class MetadataTemplate.Field

Object

BoxJSONObject

MetadataTemplate.Field

Enclosing class:

MetadataTemplate

public static class MetadataTemplate.Field
extends BoxJSONObject

Class contains information about the metadata template field.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Boolean	getCopyInstanceOnItemCopy() Gets whether the copy operation should copy the metadata along with the item.
String	getDescription() Gets the description of the field.
String	getDisplayName() Gets the display name of the field.
String	getID() Gets the ID of the template field.
Boolean	getIsHidden() Gets is metadata template field hidden.
String	getKey() Gets the key of the field.
List<String>	getOptions() Gets list of possible options for enum type of the field.
List<MetadataTemplate.Option>	getOptionsObjects() Gets list of possible options for options type of the field.
String	getType() Gets the data type of the field's value.
void	setCopyInstanceOnItemCopy(Boolean copyInstanceOnItemCopy) Sets whether the copy operation should copy the metadata along with the item.
void	setDescription(String description) Sets the description of the field.
void	setDisplayName(String displayName) Sets the display name of the field.
void	setIsHidden(boolean isHidden) Sets is metadata template field hidden.
void	setKey(String key) Sets the key of the field.
void	setOptions(List<String> options) Sets list of possible options for enum type of the field.
void	setType(String type) Sets the data type of the field's value.

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

Field

public Field()

Constructs an empty metadata template.

Field

public Field(String json)

Constructs a metadate template field from a JSON string.

Parameters:

json - the json encoded metadate template field.

Method Detail

getID

public String getID()

Gets the ID of the template field.

Returns:

the template field ID.

getType

public String getType()

Gets the data type of the field's value.

Returns:

the data type of the field's value.

setType

public void setType(String type)

Sets the data type of the field's value.

Parameters:

type - the data type of the field's value.

getKey

public String getKey()

Gets the key of the field.

Returns:

the key of the field.

setKey

public void setKey(String key)

Sets the key of the field.

Parameters:

key - the key of the field.

getDisplayName

public String getDisplayName()

Gets the display name of the field.

Returns:

the display name of the field.

setDisplayName

public void setDisplayName(String displayName)

Sets the display name of the field.

Parameters:

displayName - the display name of the field.

getIsHidden

public Boolean getIsHidden()

Gets is metadata template field hidden.

Returns:

is metadata template field hidden.

setIsHidden

public void setIsHidden(boolean isHidden)

Sets is metadata template field hidden.

Parameters:

isHidden - is metadata template field hidden?

getDescription

public String getDescription()

Gets the description of the field.

Returns:

the description of the field.

setDescription

public void setDescription(String description)

Sets the description of the field.

Parameters:

description - the description of the field.

getOptions

public List<String> getOptions()

Gets list of possible options for enum type of the field.

Returns:

list of possible options for enum type of the field.

setOptions

public void setOptions(List<String> options)

Sets list of possible options for enum type of the field.

Parameters:

options - list of possible options for enum type of the field.

getOptionsObjects

public List<MetadataTemplate.Option> getOptionsObjects()

Gets list of possible options for options type of the field.

Returns:

list of possible options for option type of the field.

getCopyInstanceOnItemCopy

public Boolean getCopyInstanceOnItemCopy()

Gets whether the copy operation should copy the metadata along with the item.

Returns:

whether the copy operation should copy the metadata along with the item.

setCopyInstanceOnItemCopy

public void setCopyInstanceOnItemCopy(Boolean copyInstanceOnItemCopy)

Sets whether the copy operation should copy the metadata along with the item.

Parameters:

copyInstanceOnItemCopy - whether the copy operation should copy the metadata along with the item.