Package com.commercetools.api.models.type

Class FieldDefinitionImpl

java.lang.Object

com.commercetools.api.models.type.FieldDefinitionImpl

All Implemented Interfaces:

FieldDefinition, io.vrap.rmf.base.client.ModelBase

public class FieldDefinitionImpl
extends Object
implements FieldDefinition, io.vrap.rmf.base.client.ModelBase

Defines a Custom Field and its meta-information. This FieldDefinition is similar to an AttributeDefinition of Product Types.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
FieldDefinitionImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TypeTextInputHint	getInputHint()	Defines the visual representation of the field in user interfaces like the Merchant Center.
LocalizedString	getLabel()	A human-readable label for the field.
String	getName()	Name of the Custom Field to define.
Boolean	getRequired()	Defines whether the field is required to have a value.
FieldType	getType()	Data type of the Custom Field to define.
int	hashCode()
void	setInputHint(TypeTextInputHint inputHint)	Defines the visual representation of the field in user interfaces like the Merchant Center.
void	setLabel(LocalizedString label)	A human-readable label for the field.
void	setName(String name)	Name of the Custom Field to define.
void	setRequired(Boolean required)	Defines whether the field is required to have a value.
void	setType(FieldType type)	Data type of the Custom Field to define.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.type.FieldDefinition

withFieldDefinition

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Constructor Details

FieldDefinitionImpl

public FieldDefinitionImpl()

create empty instance

Method Details

getType

public FieldType getType()

Data type of the Custom Field to define.

Specified by:

getType in interface FieldDefinition

Returns:

type

getName

public String getName()

Name of the Custom Field to define. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type.

Specified by:

getName in interface FieldDefinition

Returns:

name

getLabel

public LocalizedString getLabel()

A human-readable label for the field.

Specified by:

getLabel in interface FieldDefinition

Returns:

label

getRequired

public Boolean getRequired()

Defines whether the field is required to have a value.

Specified by:

getRequired in interface FieldDefinition

Returns:

required

getInputHint

public TypeTextInputHint getInputHint()

Defines the visual representation of the field in user interfaces like the Merchant Center. It is only relevant for string-based FieldTypes like CustomFieldStringType and CustomFieldLocalizedStringType.

Specified by:

getInputHint in interface FieldDefinition

Returns:

inputHint

setType

public void setType(FieldType type)

Description copied from interface: FieldDefinition

Data type of the Custom Field to define.

Specified by:

setType in interface FieldDefinition

Parameters:

type - value to be set

setName

public void setName(String name)

Description copied from interface: FieldDefinition

Name of the Custom Field to define. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type.

Specified by:

setName in interface FieldDefinition

Parameters:

name - value to be set

setLabel

public void setLabel(LocalizedString label)

Description copied from interface: FieldDefinition

A human-readable label for the field.

Specified by:

setLabel in interface FieldDefinition

Parameters:

label - value to be set

setRequired

public void setRequired(Boolean required)

Description copied from interface: FieldDefinition

Defines whether the field is required to have a value.

Specified by:

setRequired in interface FieldDefinition

Parameters:

required - value to be set

setInputHint

public void setInputHint(TypeTextInputHint inputHint)

Description copied from interface: FieldDefinition

Defines the visual representation of the field in user interfaces like the Merchant Center. It is only relevant for string-based FieldTypes like CustomFieldStringType and CustomFieldLocalizedStringType.

Specified by:

setInputHint in interface FieldDefinition

Parameters:

inputHint - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object