Package com.contentful.java.cma.model
Class CMAUiExtensionParameter
- java.lang.Object
-
- com.contentful.java.cma.model.CMAUiExtensionParameter
-
public class CMAUiExtensionParameter extends java.lang.ObjectCMAUiExtensionParameterThis class will be used to represent a UI extension parameter.
-
-
Constructor Summary
Constructors Constructor Description CMAUiExtensionParameter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CMAUiExtensionParameteraddLabel(java.lang.String key, java.lang.String value)Add a label.CMAUiExtensionParameteraddOption(java.lang.String value)Add an option, used for rendering a form.java.lang.StringgetDefaultValue()java.lang.StringgetDescription()java.lang.StringgetId()java.util.List<java.util.Map<java.lang.String,java.lang.String>>getLabels()java.lang.StringgetName()java.util.List<java.lang.Object>getOptions()CMAUiExtensionParameterTypegetType()booleanisRequired()CMAUiExtensionParametersetDefaultValue(java.lang.String defaultValue)Set the default value of this parameter.CMAUiExtensionParametersetDescription(java.lang.String description)Set the description of this parameter.CMAUiExtensionParametersetId(java.lang.String id)Sets the id for this parameter.CMAUiExtensionParametersetName(java.lang.String name)Sets the name for this parameter.CMAUiExtensionParametersetRequired(boolean required)Sets therequiredattribute value.CMAUiExtensionParametersetType(CMAUiExtensionParameterType type)Sets the type for this parameter.java.lang.StringtoString()
-
-
-
Method Detail
-
getId
public java.lang.String getId()
- Returns:
- the
idattribute of this parameter.
-
setId
public CMAUiExtensionParameter setId(java.lang.String id)
Sets the id for this parameter.- Parameters:
id- the id to be set- Returns:
- this
CMAUiExtensionParameterinstance
-
getName
public java.lang.String getName()
- Returns:
- the
nameattribute of this parameter.
-
setName
public CMAUiExtensionParameter setName(java.lang.String name)
Sets the name for this parameter.- Parameters:
name- the name to be set- Returns:
- this
CMAUiExtensionParameterinstance
-
getDescription
public java.lang.String getDescription()
- Returns:
- the
namedescription of this parameter.
-
setDescription
public CMAUiExtensionParameter setDescription(java.lang.String description)
Set the description of this parameter.- Parameters:
description- the description of this parameter.- Returns:
- this
CMAUiExtensionParameterinstance.
-
getType
public CMAUiExtensionParameterType getType()
- Returns:
- the
typeattribute of this parameter.
-
setType
public CMAUiExtensionParameter setType(CMAUiExtensionParameterType type)
Sets the type for this parameter.- Parameters:
type- the type to be set.- Returns:
- this
CMAUiExtensionParameterinstance.
-
isRequired
public boolean isRequired()
- Returns:
- the
requiredattribute of this parameter.
-
setRequired
public CMAUiExtensionParameter setRequired(boolean required)
Sets therequiredattribute value.- Parameters:
required- boolean indicating whether or not this parameter is required.- Returns:
- this
CMAUiExtensionParameterinstance.
-
getDefaultValue
public java.lang.String getDefaultValue()
- Returns:
- the
defaultValuedescription of this parameter.
-
setDefaultValue
public CMAUiExtensionParameter setDefaultValue(java.lang.String defaultValue)
Set the default value of this parameter.- Parameters:
defaultValue- the default value of this parameter.- Returns:
- this
CMAUiExtensionParameterinstance.
-
getOptions
public java.util.List<java.lang.Object> getOptions()
- Returns:
- the options of this parameter.
-
addOption
public CMAUiExtensionParameter addOption(java.lang.String value)
Add an option, used for rendering a form.- Parameters:
value- the value of the option.- Returns:
- this
CMAUiExtensionParameterinstance.
-
getLabels
public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getLabels()
- Returns:
- the options of this parameter.
-
addLabel
public CMAUiExtensionParameter addLabel(java.lang.String key, java.lang.String value)
Add a label.- Parameters:
key- the key of the label.value- the value of the label.- Returns:
- this
CMAUiExtensionParameterinstance.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object- Returns:
- a human readable string, representing the object.
-
-