com.box.sdk

Class MetadataTemplate.FieldOperation

Object

BoxJSONObject

MetadataTemplate.FieldOperation

Enclosing class:

MetadataTemplate

public static class MetadataTemplate.FieldOperation
extends BoxJSONObject

Posssible operations that can be performed in a Metadata template.

• Add an enum option
• Edit an enum option
• Remove an enum option
• Add a field
• Edit a field
• Remove a field
• Edit template
• Reorder the enum option
• Reorder the field list

Constructor Summary

Constructors

Constructor and Description
FieldOperation() Constructs an empty FieldOperation.
FieldOperation(String json) Constructs a Field operation from a JSON string.

Method Summary

Modifier and Type	Method and Description
MetadataTemplate.Field	getData() Gets the data associated with the operation.
String	getEnumOptionKey() Gets the enum option key.
List<String>	getEnumOptionKeys() Gets the list of keys of the Enum options.
String	getFieldKey() Gets the field key.
List<String>	getFieldKeys() Gets the list of field keys.
MetadataTemplate.Operation	getOp() Gets the operation.
void	setData(MetadataTemplate.Field data) Sets the data.
void	setEnumOptionKey(String enumOptionKey) Sets the enum option key.
void	setEnumOptionKeys(List<String> enumOptionKeys) Sets the list of the enum option keys.
void	setFieldKey(String fieldKey) Sets the field key.
void	setFieldKeys(List<String> fieldKeys) Sets the list of the field keys.
void	setOp(MetadataTemplate.Operation op) Sets the operation.

Methods inherited from class BoxJSONObject

clearPendingChanges, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

FieldOperation

public FieldOperation()

Constructs an empty FieldOperation.

FieldOperation

public FieldOperation(String json)

Constructs a Field operation from a JSON string.

Parameters:

json - the json encoded metadate template field.

Method Detail

getOp

public MetadataTemplate.Operation getOp()

Gets the operation.

Returns:

the operation

getData

public MetadataTemplate.Field getData()

Gets the data associated with the operation.

Returns:

the field object representing the data

getFieldKey

public String getFieldKey()

Gets the field key.

Returns:

the field key

getFieldKeys

public List<String> getFieldKeys()

Gets the list of field keys.

Returns:

the list of Strings

getEnumOptionKeys

public List<String> getEnumOptionKeys()

Gets the list of keys of the Enum options.

Returns:

the list of Strings

setOp

public void setOp(MetadataTemplate.Operation op)

Sets the operation.

Parameters:

op - the operation

setData

public void setData(MetadataTemplate.Field data)

Sets the data.

Parameters:

data - the Field object representing the data

setFieldKey

public void setFieldKey(String fieldKey)

Sets the field key.

Parameters:

fieldKey - the key of the field

setFieldKeys

public void setFieldKeys(List<String> fieldKeys)

Sets the list of the field keys.

Parameters:

fieldKeys - the list of strings

setEnumOptionKeys

public void setEnumOptionKeys(List<String> enumOptionKeys)

Sets the list of the enum option keys.

Parameters:

enumOptionKeys - the list of Strings

getEnumOptionKey

public String getEnumOptionKey()

Gets the enum option key.

Returns:

the enum option key

setEnumOptionKey

public void setEnumOptionKey(String enumOptionKey)

Sets the enum option key.

Parameters:

enumOptionKey - the enum option key