com.adobe.cq.commerce.magento.graphql.CustomizableCheckboxOptionQuery 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.AbstractQuery;
import com.shopify.graphql.support.Fragment;

/**
 * CustomizableCheckbbixOption contains information about a set of checkbox values that are defined as
 * part of a customizable option.
 */
public class CustomizableCheckboxOptionQuery extends AbstractQuery {
    CustomizableCheckboxOptionQuery(StringBuilder _queryBuilder) {
        super(_queryBuilder);
    }

    /**
     * Option ID.
     */
    public CustomizableCheckboxOptionQuery optionId() {
        startField("option_id");

        return this;
    }

    /**
     * Indicates whether the option is required.
     */
    public CustomizableCheckboxOptionQuery required() {
        startField("required");

        return this;
    }

    /**
     * The order in which the option is displayed.
     */
    public CustomizableCheckboxOptionQuery sortOrder() {
        startField("sort_order");

        return this;
    }

    /**
     * The display name for this option.
     */
    public CustomizableCheckboxOptionQuery title() {
        startField("title");

        return this;
    }

    /**
     * An array that defines a set of checkbox values.
     */
    public CustomizableCheckboxOptionQuery value(CustomizableCheckboxValueQueryDefinition queryDef) {
        startField("value");

        _queryBuilder.append('{');
        queryDef.define(new CustomizableCheckboxValueQuery(_queryBuilder));
        _queryBuilder.append('}');

        return this;
    }

    /**
     * Creates a GraphQL "named" fragment with the specified query type definition.
     * The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.
     * 
     * @param name The name of the fragment, must be unique for a given GraphQL request.
     * @param queryDef The fragment definition.
     * @return The fragment of a given generics type.
     */
    public static Fragment createFragment(String name, CustomizableCheckboxOptionQueryDefinition queryDef) {
        StringBuilder sb = new StringBuilder();
        queryDef.define(new CustomizableCheckboxOptionQuery(sb));
        return new Fragment<>(name, "CustomizableCheckboxOption", sb.toString());
    }

    /**
     * Adds a CustomizableCheckboxOptionQuery fragment reference at the current position of the query.
     * For example for a fragment named test, calling this method will add the
     * reference ...test in the query. For GraphQL types implementing an interface, there
     * will be some similar methods using the Query type of each implemented interface.
     * 
     * @param fragment The fragment to reference.
     */
    public CustomizableCheckboxOptionQuery addFragmentReference(Fragment fragment) {
        startField("..." + fragment.getName());
        return this;
    }

    /**
     * Adds a CustomizableOptionInterfaceQuery fragment reference at the current position of the query.
     * For example for a fragment named test, calling this method will add the
     * reference ...test in the query.
     * 
     * @param fragment The fragment to reference.
     */
    public CustomizableCheckboxOptionQuery addCustomizableOptionInterfaceFragmentReference(Fragment fragment) {
        startField("..." + fragment.getName());
        return this;
    }
}