io.sphere.sdk.attributes.AttributeDefinitionBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of products Show documentation
products
The newest version!
package io.sphere.sdk.attributes;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.models.Base;
import io.sphere.sdk.models.LocalizedStrings;

/**
 * Describes the structure and validation logic of a product attribute.
 */
@JsonDeserialize()
class AttributeDefinitionBase extends Base implements AttributeDefinition {

    private final T attributeType;
    private final String name;
    private final LocalizedStrings label;
    private final boolean isRequired;
    private final AttributeConstraint attributeConstraint;
    private final boolean isSearchable;

    @JsonCreator
    AttributeDefinitionBase(T attributeType, String name, LocalizedStrings label, boolean isRequired,
                            AttributeConstraint attributeConstraint, boolean isSearchable) {
        this.attributeType = attributeType;
        this.name = name;
        this.label = label;
        this.isRequired = isRequired;
        this.attributeConstraint = attributeConstraint;
        this.isSearchable = isSearchable;
    }

    /**
     * Describes the type of the attribute.
     * @return the type of the attribute
     */
    @Override
    @JsonProperty("type")
    public T getAttributeType() {
        return attributeType;
    }

    /**
     * The unique name of the attribute used in the API.
     * @return name of the attribute
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * A human-readable label for the attribute.
     * @return label for the attribute
     */
    @Override
    public LocalizedStrings getLabel() {
        return label;
    }

    /**
     * Whether the attribute is required to have a value.
     * @return true if required else false
     */
    @Override
    public boolean getIsRequired() {
        return isRequired;
    }

    /**
     * Describes how an attribute or a set of attributes should be validated across all variants of a product.
     * @return definition of validation logic
     */
    @Override
    public AttributeConstraint getAttributeConstraint() {
        return attributeConstraint;
    }

    /**
     * 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.
     *
     * @return true if searchable, false if not
     */
    @Override
    public boolean getIsSearchable() {
        return isSearchable;
    }
}