com.contentful.java.cma.model

Class CMAUiExtensionParameter

java.lang.Object

com.contentful.java.cma.model.CMAUiExtensionParameter

public class CMAUiExtensionParameter
extends Object

CMAUiExtensionParameter

This class will be used to represent a UI extension parameter.

Constructor Summary

Constructors

Constructor and Description
CMAUiExtensionParameter()

Method Summary

Modifier and Type	Method and Description
CMAUiExtensionParameter	addLabel(String key, String value) Add a label.
CMAUiExtensionParameter	addOption(String value) Add an option, used for rendering a form.
String	getDefaultValue()
String	getDescription()
String	getId()
List<Map<String,String>>	getLabels()
String	getName()
List<Object>	getOptions()
CMAUiExtensionParameterType	getType()
boolean	isRequired()
CMAUiExtensionParameter	setDefaultValue(String defaultValue) Set the default value of this parameter.
CMAUiExtensionParameter	setDescription(String description) Set the description of this parameter.
CMAUiExtensionParameter	setId(String id) Sets the id for this parameter.
CMAUiExtensionParameter	setName(String name) Sets the name for this parameter.
CMAUiExtensionParameter	setRequired(boolean required) Sets the required attribute value.
CMAUiExtensionParameter	setType(CMAUiExtensionParameterType type) Sets the type for this parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAUiExtensionParameter

public CMAUiExtensionParameter()

Method Detail

getId

public String getId()

Returns:

the id attribute of this parameter.

setId

public CMAUiExtensionParameter setId(String id)

Sets the id for this parameter.

Parameters:

id - the id to be set

Returns:

this CMAUiExtensionParameter instance

getName

public String getName()

Returns:

the name attribute of this parameter.

setName

public CMAUiExtensionParameter setName(String name)

Sets the name for this parameter.

Parameters:

name - the name to be set

Returns:

this CMAUiExtensionParameter instance

getDescription

public String getDescription()

Returns:

the name description of this parameter.

setDescription

public CMAUiExtensionParameter setDescription(String description)

Set the description of this parameter.

Parameters:

description - the description of this parameter.

Returns:

this CMAUiExtensionParameter instance.

getType

public CMAUiExtensionParameterType getType()

Returns:

the type attribute of this parameter.

setType

public CMAUiExtensionParameter setType(CMAUiExtensionParameterType type)

Sets the type for this parameter.

Parameters:

type - the type to be set.

Returns:

this CMAUiExtensionParameter instance.

isRequired

public boolean isRequired()

Returns:

the required attribute of this parameter.

setRequired

public CMAUiExtensionParameter setRequired(boolean required)

Sets the required attribute value.

Parameters:

required - boolean indicating whether or not this parameter is required.

Returns:

this CMAUiExtensionParameter instance.

getDefaultValue

public String getDefaultValue()

Returns:

the defaultValue description of this parameter.

setDefaultValue

public CMAUiExtensionParameter setDefaultValue(String defaultValue)

Set the default value of this parameter.

Parameters:

defaultValue - the default value of this parameter.

Returns:

this CMAUiExtensionParameter instance.

getOptions

public List<Object> getOptions()

Returns:

the options of this parameter.

addOption

public CMAUiExtensionParameter addOption(String value)

Add an option, used for rendering a form.

Parameters:

value - the value of the option.

Returns:

this CMAUiExtensionParameter instance.

getLabels

public List<Map<String,String>> getLabels()

Returns:

the options of this parameter.

addLabel

public CMAUiExtensionParameter addLabel(String key,
                                        String value)

Add a label.

Parameters:

key - the key of the label.

value - the value of the label.

Returns:

this CMAUiExtensionParameter instance.

toString

public String toString()

Overrides:

toString in class Object

Returns:

a human readable string, representing the object.