Package org.topbraidlive.client.java.graphql.platform

Class _FieldGroupQuery

java.lang.Object

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

org.topbraidlive.client.java.graphql.platform._FieldGroupQuery

public class _FieldGroupQuery
extends AbstractQuery<_FieldGroupQuery>

Metadata about a field group.

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method	Description
_FieldGroupQuery	addFragmentReference(Fragment<_FieldGroupQuery> fragment)	Adds a _FieldGroupQuery fragment reference at the current position of the query.
static Fragment<_FieldGroupQuery>	createFragment(String name, _FieldGroupQueryDefinition queryDef)	Creates a GraphQL "named" fragment with the specified query type definition.
_FieldGroupQuery	fields(_FieldShapeQueryDefinition queryDef)	The fields of the group.
_FieldGroupQuery	hasViewGadget()	True if this property group declares a tosh:viewGadget.
_FieldGroupQuery	isClosed()	True if this property group has been marked to be closed, using tosh:closed=true.
_FieldGroupQuery	label()	A display label for the field group or null for the default group.
_FieldGroupQuery	order()	A number representing the relative ordering of this group compared to others.
_FieldGroupQuery	uri()	The URI of the field group or null for the default group.
_FieldGroupQuery	viewGadget()	The URI of the specified tosh:viewGadget, or null.
_FieldGroupQuery	viewGroupDescription()	The description that shall appear under the group's label, or null.

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

fields

public _FieldGroupQuery fields(_FieldShapeQueryDefinition queryDef)

The fields of the group.

hasViewGadget

public _FieldGroupQuery hasViewGadget()

True if this property group declares a tosh:viewGadget. This feature should not be used outside of internal TopQuadrant projects.

isClosed

public _FieldGroupQuery isClosed()

True if this property group has been marked to be closed, using tosh:closed=true.

label

public _FieldGroupQuery label()

A display label for the field group or null for the default group.

order

public _FieldGroupQuery order()

A number representing the relative ordering of this group compared to others. Defaults to 0.

uri

public _FieldGroupQuery uri()

The URI of the field group or null for the default group.

viewGadget

public _FieldGroupQuery viewGadget()

The URI of the specified tosh:viewGadget, or null. This feature should not be used outside of internal TopQuadrant projects.

viewGroupDescription

public _FieldGroupQuery viewGroupDescription()

The description that shall appear under the group's label, or null.

createFragment

public static Fragment<_FieldGroupQuery> createFragment(String name,
                                                        _FieldGroupQueryDefinition 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 _FieldGroupQuery addFragmentReference(Fragment<_FieldGroupQuery> fragment)

Adds a _FieldGroupQuery 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.