Package org.brapi.schematools.core.openapi.generator.options

Class ListGetOptions

java.lang.Object
org.brapi.schematools.core.options.AbstractGeneratorSubOptions
org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions
org.brapi.schematools.core.openapi.generator.options.ListGetOptions
All Implemented Interfaces:
Options, Validatable
public class ListGetOptions extends AbstractOpenAPIOptions
Provides options for the generation of List Get Endpoints

  • Constructor Details

    • ListGetOptions

      public ListGetOptions()

  • 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 AbstractOpenAPIOptions
      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(ListGetOptions 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

    • isPagedFor

      public boolean isPagedFor(String name)
      Determines if the List Endpoint is paged for any primary model. Returns true if paged is set to true for any type or uses pagedDefault
      Parameters:
      name - the name of the primary model
      Returns:
      true if the List Endpoint is paged for any primary model, false otherwise

    • isPagedFor

      public boolean isPagedFor(BrAPIType type)
      Determines if the List Endpoint is paged for any primary model. Returns true if paged is set to true for any type or uses pagedDefault
      Parameters:
      type - the primary model
      Returns:
      true if the List Endpoint is paged for any primary model, false otherwise

    • setPagingFor

      public ListGetOptions setPagingFor(String name, boolean generate)
      Sets if the Endpoint is paged for a specific primary model.
      Parameters:
      name - the name of the primary model
      generate - true if the Endpoint is paged for a specific primary model, false
      Returns:
      the options for chaining

    • setPagingFor

      public ListGetOptions setPagingFor(BrAPIType type, boolean generate)
      Sets if the Endpoint is paged for a specific primary model.
      Parameters:
      type - the primary model
      generate - true if the Endpoint is paged for a specific primary model, false
      Returns:
      the options for chaining

    • hasInputFor

      public boolean hasInputFor(String name)
      Determines if the List Endpoint is has an input for any primary model. Returns true if inputFor is set to true for the primary model
      Parameters:
      name - the name of the primary model
      Returns:
      true if the List Endpoint has an input for the primary model, false otherwise

    • hasInputFor

      public boolean hasInputFor(BrAPIType type)
      Determines if the List Endpoint has an input for any primary model. Returns true if inputFor is set to true for the primary model
      Parameters:
      type - the primary model
      Returns:
      true if the List Endpoint has an input for the primary model, false otherwise

    • setInputFor

      public ListGetOptions setInputFor(String name, boolean generate)
      Sets if the Endpoint has an input for a specific primary model.
      Parameters:
      name - the name of the primary model
      generate - true if the Endpoint has an input for a specific primary model, false
      Returns:
      the options for chaining

    • setInputFor

      public ListGetOptions setInputFor(BrAPIType type, boolean generate)
      Sets if the Endpoint has an input for a specific primary model.
      Parameters:
      type - the primary model
      generate - true if the Endpoint has an input for a specific primary model, false
      Returns:
      the options for chaining

    • isUsingPropertyFromRequestFor

      public boolean isUsingPropertyFromRequestFor(BrAPIObjectType type, BrAPIObjectProperty property)
      Gets whether a property from the Request is used in the List query
      Parameters:
      type - The BrAPI Object type
      property - The BrAPI property
      Returns:
      true if the property from the Request is used in the List query

    • setUsingPropertyFromRequestFor

      public ListGetOptions setUsingPropertyFromRequestFor(BrAPIObjectType type, BrAPIObjectProperty property, Boolean propertiesFromRequest)
      Gets whether a property from the Request is used in the List query
      Parameters:
      type - The BrAPI Object type
      property - The BrAPI property
      propertiesFromRequest - true if the property from the Request is used in the List query
      Returns:
      the options for chaining