com.adobe.cq.commerce.magento.graphql

Class CustomizableOptionInterfaceQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<CustomizableOptionInterfaceQuery>

com.adobe.cq.commerce.magento.graphql.CustomizableOptionInterfaceQuery

public class CustomizableOptionInterfaceQuery
extends AbstractQuery<CustomizableOptionInterfaceQuery>

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

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
CustomizableOptionInterfaceQuery	addFragmentReference(Fragment<CustomizableOptionInterfaceQuery> fragment) Adds a CustomizableOptionInterfaceQuery fragment reference at the current position of the query.
static Fragment<CustomizableOptionInterfaceQuery>	createFragment(String name, CustomizableOptionInterfaceQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CustomizableOptionInterfaceQuery	onCustomizableAreaOption(CustomizableAreaOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableCheckboxOption(CustomizableCheckboxOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableDateOption(CustomizableDateOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableDropDownOption(CustomizableDropDownOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableFieldOption(CustomizableFieldOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableFileOption(CustomizableFileOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableMultipleOption(CustomizableMultipleOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	onCustomizableRadioOption(CustomizableRadioOptionQueryDefinition queryDef)
CustomizableOptionInterfaceQuery	optionId() Deprecated. Use `uid` instead
CustomizableOptionInterfaceQuery	required() Indicates whether the option is required.
CustomizableOptionInterfaceQuery	sortOrder() The order in which the option is displayed.
CustomizableOptionInterfaceQuery	title() The display name for this option.
CustomizableOptionInterfaceQuery	uid() The unique ID for a `CustomizableOptionInterface` object.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

optionId

@Deprecated
public CustomizableOptionInterfaceQuery optionId()

Deprecated. Use `uid` instead

Option ID.

required

public CustomizableOptionInterfaceQuery required()

Indicates whether the option is required.

sortOrder

public CustomizableOptionInterfaceQuery sortOrder()

The order in which the option is displayed.

title

public CustomizableOptionInterfaceQuery title()

The display name for this option.

uid

public CustomizableOptionInterfaceQuery uid()

The unique ID for a `CustomizableOptionInterface` object.

onCustomizableAreaOption

public CustomizableOptionInterfaceQuery onCustomizableAreaOption(CustomizableAreaOptionQueryDefinition queryDef)

onCustomizableCheckboxOption

public CustomizableOptionInterfaceQuery onCustomizableCheckboxOption(CustomizableCheckboxOptionQueryDefinition queryDef)

onCustomizableDateOption

public CustomizableOptionInterfaceQuery onCustomizableDateOption(CustomizableDateOptionQueryDefinition queryDef)

onCustomizableDropDownOption

public CustomizableOptionInterfaceQuery onCustomizableDropDownOption(CustomizableDropDownOptionQueryDefinition queryDef)

onCustomizableFieldOption

public CustomizableOptionInterfaceQuery onCustomizableFieldOption(CustomizableFieldOptionQueryDefinition queryDef)

onCustomizableFileOption

public CustomizableOptionInterfaceQuery onCustomizableFileOption(CustomizableFileOptionQueryDefinition queryDef)

onCustomizableMultipleOption

public CustomizableOptionInterfaceQuery onCustomizableMultipleOption(CustomizableMultipleOptionQueryDefinition queryDef)

onCustomizableRadioOption

public CustomizableOptionInterfaceQuery onCustomizableRadioOption(CustomizableRadioOptionQueryDefinition queryDef)

createFragment

public static Fragment<CustomizableOptionInterfaceQuery> createFragment(String name,
                                                                        CustomizableOptionInterfaceQueryDefinition queryDef)

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.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public CustomizableOptionInterfaceQuery addFragmentReference(Fragment<CustomizableOptionInterfaceQuery> fragment)

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. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.