io.sphere.sdk.products.attributes

Interface AttributeDefinition

public interface AttributeDefinition

Attribute definitions describe a product attribute and allow you to define some meta-information associated with the attribute (like whether it should be searchable or its constraints).

See Also:

AttributeDefinitionBuilder

Method Summary

Modifier and Type	Method and Description
AttributeConstraint	getAttributeConstraint() Describes how an attribute or a set of attributes should be validated across all variants of a product.
AttributeType	getAttributeType() Describes the type of the attribute.
TextInputHint	getInputHint()
LocalizedString	getInputTip() Additional information about the attribute that aids content managers when setting product details.
LocalizedString	getLabel() A human-readable label for the attribute.
String	getName() The unique name of the attribute used in the API.
Boolean	isRequired() Whether the attribute is required to have a value.
Boolean	isSearchable() Whether the attribute's values should generally be enabled in product search.

Method Detail

getAttributeType

AttributeType getAttributeType()

Describes the type of the attribute.

Returns:

the type of the attribute

getName

String getName()

The unique name of the attribute used in the API.

Returns:

name of the attribute

getLabel

LocalizedString getLabel()

A human-readable label for the attribute.

Returns:

label for the attribute

isRequired

Boolean isRequired()

Whether the attribute is required to have a value.

Returns:

true if required else false

getAttributeConstraint

AttributeConstraint getAttributeConstraint()

Describes how an attribute or a set of attributes should be validated across all variants of a product.

Returns:

definition of validation logic

isSearchable

Boolean isSearchable()

Whether the attribute's values should generally be enabled in product search. The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there.

Returns:

true if searchable, false if not

getInputHint

TextInputHint getInputHint()

getInputTip

@Nullable
LocalizedString getInputTip()

Additional information about the attribute that aids content managers when setting product details.

Returns:

input tip