com.adobe.cq.commerce.magento.graphql.WebsiteQuery 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;
/**
* Website is deprecated because it is should not be used on storefront. The type contains information
* about a website
*/
public class WebsiteQuery extends AbstractQuery {
WebsiteQuery(StringBuilder _queryBuilder) {
super(_queryBuilder);
}
/**
* A code assigned to the website to identify it
*
* @deprecated The field should not be used on the storefront.
*/
@Deprecated
public WebsiteQuery code() {
startField("code");
return this;
}
/**
* The default group ID that the website has
*
* @deprecated The field should not be used on the storefront.
*/
@Deprecated
public WebsiteQuery defaultGroupId() {
startField("default_group_id");
return this;
}
/**
* The ID number assigned to the website
*
* @deprecated The field should not be used on the storefront.
*/
@Deprecated
public WebsiteQuery id() {
startField("id");
return this;
}
/**
* Specifies if this is the default website
*
* @deprecated The field should not be used on the storefront.
*/
@Deprecated
public WebsiteQuery isDefault() {
startField("is_default");
return this;
}
/**
* The website name. Websites use this name to identify it easier.
*
* @deprecated The field should not be used on the storefront.
*/
@Deprecated
public WebsiteQuery name() {
startField("name");
return this;
}
/**
* The attribute to use for sorting websites
*
* @deprecated The field should not be used on the storefront.
*/
@Deprecated
public WebsiteQuery sortOrder() {
startField("sort_order");
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, WebsiteQueryDefinition queryDef) {
StringBuilder sb = new StringBuilder();
queryDef.define(new WebsiteQuery(sb));
return new Fragment<>(name, "Website", sb.toString());
}
/**
* Adds a WebsiteQuery 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 WebsiteQuery addFragmentReference(Fragment fragment) {
startField("..." + fragment.getName());
return this;
}
}