Package org.brapi.schematools.core.graphql.options

Class ListQueryOptions

java.lang.Object
org.brapi.schematools.core.options.AbstractGeneratorSubOptions
org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions
org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions
org.brapi.schematools.core.graphql.options.ListQueryOptions
All Implemented Interfaces:
Options, Validatable
public class ListQueryOptions extends AbstractGraphQLQueryOptions
Provides options for the generation of List Queries

  • Constructor Details

    • ListQueryOptions

      public ListQueryOptions()

  • Method Details

    • validate

      public Validation validate()
      Description copied from class: AbstractGeneratorSubOptions
      Checks if the current options are valid, return a list of errors if the options are not valid
      Specified by:
      validate in interface Validatable
      Overrides:
      validate in class AbstractGraphQLQueryOptions
      Returns:
      a Validation object than can be used queried to find if the options are valid and any errors if the options are not valid

    • override

      public void override(ListQueryOptions overrideOptions)
      Overrides the values in this Options Object from the provided Options Object if they are non-null
      Parameters:
      overrideOptions - the options which will be used to override this Options Object

    • hasPaging

      public boolean hasPaging()
      Determine if any list query has paging
      Returns:
      true if any list query has paging. false otherwise

    • isPagedFor

      public final boolean isPagedFor(@NonNull @NonNull String name)
      Determines if the Query is paged for a specific primary model
      Parameters:
      name - the name of the primary model
      Returns:
      true if the Query is paged for a specific primary model, false otherwise

    • isPagedFor

      public final boolean isPagedFor(@NonNull @NonNull BrAPIType type)
      Determines if the Query is paged for a specific primary model
      Parameters:
      type - the primary model
      Returns:
      true if the Query is paged for a specific primary model, false otherwise

    • setPagedFor

      public final ListQueryOptions setPagedFor(String name, boolean hasInput)
      Sets if the Query is paged for a specific primary model
      Parameters:
      name - the name of the primary model
      hasInput - true if the Query is paged for a specific primary model, false otherwise
      Returns:
      the options for chaining