com.adobe.cq.commerce.magento.graphql.CustomizableOptionInterface Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 *
 *    Copyright 2020 Adobe. All rights reserved.
 *    This file is licensed to you under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License. You may obtain a copy
 *    of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software distributed under
 *    the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 *    OF ANY KIND, either express or implied. See the License for the specific language
 *    governing permissions and limitations under the License.
 *
 ******************************************************************************/

package com.adobe.cq.commerce.magento.graphql;

import com.shopify.graphql.support.CustomFieldInterface;

/**
 * The CustomizableOptionInterface contains basic information about a customizable option. It can be
 * implemented by several types of configurable options.
 */

public interface CustomizableOptionInterface extends CustomFieldInterface {
    String getGraphQlTypeName();

    /**
     * Option ID.
     */
    Integer getOptionId();

    /**
     * Indicates whether the option is required.
     */
    Boolean getRequired();

    /**
     * The order in which the option is displayed.
     */
    Integer getSortOrder();

    /**
     * The display name for this option.
     */
    String getTitle();
}