com.adobe.cq.commerce.magento.graphql.BundleItemOptionQuery Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of magento-graphql Show documentation
Show all versions of magento-graphql Show documentation
AEM bundle for the Magento GraphQL data models and query builders
/*******************************************************************************
*
* 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;
/**
* BundleItemOption defines characteristics and options for a specific bundle item.
*/
public class BundleItemOptionQuery extends AbstractQuery {
BundleItemOptionQuery(StringBuilder _queryBuilder) {
super(_queryBuilder);
}
/**
* Indicates whether the customer can change the number of items for this option.
*/
public BundleItemOptionQuery canChangeQuantity() {
startField("can_change_quantity");
return this;
}
/**
* The ID assigned to the bundled item option.
*/
public BundleItemOptionQuery id() {
startField("id");
return this;
}
/**
* Indicates whether this option is the default option.
*/
public BundleItemOptionQuery isDefault() {
startField("is_default");
return this;
}
/**
* The text that identifies the bundled item option.
*/
public BundleItemOptionQuery label() {
startField("label");
return this;
}
/**
* When a bundle item contains multiple options, the relative position of this option compared to the
* other options.
*/
public BundleItemOptionQuery position() {
startField("position");
return this;
}
/**
* The price of the selected option.
*/
public BundleItemOptionQuery price() {
startField("price");
return this;
}
/**
* One of FIXED, PERCENT, or DYNAMIC.
*/
public BundleItemOptionQuery priceType() {
startField("price_type");
return this;
}
/**
* Contains details about this product option.
*/
public BundleItemOptionQuery product(ProductInterfaceQueryDefinition queryDef) {
startField("product");
_queryBuilder.append('{');
queryDef.define(new ProductInterfaceQuery(_queryBuilder));
_queryBuilder.append('}');
return this;
}
/**
* Indicates the quantity of this specific bundle item.
*
* @deprecated The `qty` is deprecated. Use `quantity` instead.
*/
@Deprecated
public BundleItemOptionQuery qty() {
startField("qty");
return this;
}
/**
* Indicates the quantity of this specific bundle item.
*/
public BundleItemOptionQuery quantity() {
startField("quantity");
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, BundleItemOptionQueryDefinition queryDef) {
StringBuilder sb = new StringBuilder();
queryDef.define(new BundleItemOptionQuery(sb));
return new Fragment<>(name, "BundleItemOption", sb.toString());
}
/**
* Adds a BundleItemOptionQuery 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 BundleItemOptionQuery addFragmentReference(Fragment fragment) {
startField("..." + fragment.getName());
return this;
}
}