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

Class SearchOptions

java.lang.Object

org.brapi.schematools.core.options.AbstractGeneratorSubOptions

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

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

All Implemented Interfaces:

Options, Validatable

public class SearchOptions
extends AbstractOpenAPIOptions

Provides options for the generation of Search Post and Get Endpoints

Constructor Summary

Constructors

Constructor	Description
SearchOptions()

Method Summary

Modifier and Type	Method	Description
final String	getRetrieveDescriptionFormat(BrAPIType type)	Gets the retrieve description for a specific primary model
final String	getSubmitDescriptionFormat(BrAPIType type)	Gets the submit description for a specific primary model
void	override(SearchOptions overrideOptions)	Overrides the values in this Options Object from the provided Options Object if they are non-null
Validation	validate()	Checks if the current options are valid, return a list of errors if the options are not valid

Methods inherited from class org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions

getSummaryFor, getSummaryFor, override

Methods inherited from class org.brapi.schematools.core.options.AbstractGeneratorSubOptions

getDescriptionFor, getDescriptionFor, isGenerating, isGeneratingFor, isGeneratingFor, override, setGenerateFor, setGenerateFor

Methods inherited from class java.lang.Object

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

Constructor Details

SearchOptions

public SearchOptions()

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(SearchOptions 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

getSubmitDescriptionFormat

public final String getSubmitDescriptionFormat(BrAPIType type)

Gets the submit description for a specific primary model

Parameters:

type - the primary model

Returns:

the submit description for a specific primary model

getRetrieveDescriptionFormat

public final String getRetrieveDescriptionFormat(BrAPIType type)

Gets the retrieve description for a specific primary model

Parameters:

type - the primary model

Returns:

the retrieve description for a specific primary model