Package org.brapi.schematools.analyse

Class APIRequestOptions

java.lang.Object
org.brapi.schematools.analyse.APIRequestOptions
All Implemented Interfaces:
org.brapi.schematools.core.options.Options, org.brapi.schematools.core.validiation.Validatable
public class APIRequestOptions extends Object implements org.brapi.schematools.core.options.Options
Provides API Request options for the analysis of endpoints

  • Constructor Details

    • APIRequestOptions

      public APIRequestOptions()

  • Method Details

    • validate

      public org.brapi.schematools.core.validiation.Validation validate()
      Specified by:
      validate in interface org.brapi.schematools.core.validiation.Validatable

    • override

      public void override(APIRequestOptions 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

    • isAnalysingEntity

      public Boolean isAnalysingEntity(String name)
      Gets if to analysis for a specific primary mode. Use setAnalysingEntityFor(String, Boolean) to override this value.
      Parameters:
      name - the name of the primary model
      Returns:
      property name for a specific primary model

    • setAnalysingEntityFor

      public APIRequestOptions setAnalysingEntityFor(String name, Boolean analyse)
      Sets if to do analysis for a specific primary model.
      Parameters:
      name - the name of the primary model
      analyse - true if to do analyse for this model, false otherwise
      Returns:
      the options for chaining

    • getRequiredParametersFor

      public List<Parameter> getRequiredParametersFor(String name)
      Gets the required parameters for a specific primary model. Use setRequiredParametersFor(String, List) to override this value.
      Parameters:
      name - the name of the primary model
      Returns:
      the required parameters for a specific primary model

    • setRequiredParametersFor

      public APIRequestOptions setRequiredParametersFor(String name, List<Parameter> requiredParameters)
      Sets the required parameters for a specific primary model.
      Parameters:
      name - the name of the primary model
      requiredParameters - the required parameters for a specific primary model
      Returns:
      the options for chaining

    • getPrerequisitesFor

      public List<String> getPrerequisitesFor(String name)
      Gets the prerequisites for a specific primary model. Use setPrerequisitesFor(String, List) to override this value.
      Parameters:
      name - the name of the primary model
      Returns:
      the required parameters a specific primary model

    • setPrerequisitesFor

      public APIRequestOptions setPrerequisitesFor(String name, List<String> requiredParameters)
      Sets the prerequisites for a specific primary model.
      Parameters:
      name - the name of the primary model
      requiredParameters - the prerequisites for a specific primary model
      Returns:
      the options for chaining