Package com.easy_model.webservice.model

Class ModelController

java.lang.Object

com.easy_model.webservice.model.ModelController

@RestController
@Transactional
public class ModelController
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODEL_ID
static final String	MODEL_ID_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
ModelController(ModelRepository modelRepository, VariableRepository variableRepository, XLHandleManager xlHandleManager, EntityService entityService, UserRepository userRepository, Events events, EninAPIService eninAPIService, OpenAiServiceImplementation openAiServiceImplementation)	Initializes the model controller and establish link to database Creator function that ensures that the model is connected to a document

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Long>	addModel(@Valid ModelData modelData, Long templateId, boolean copyVariableValues, Principal principal)
org.springframework.http.ResponseEntity<Long>	createModelFromEnin(@Valid CompanyNameRecord companyNameRecord, Integer startYear, String modelName, boolean doImportGroupFigures, Integer unitDivider, Principal principal)
org.springframework.http.ResponseEntity<List<String>>	cypress(Model model)	Printing code for an entire model to use in FullModelTest
String	debug()
org.springframework.http.ResponseEntity<Void>	deleteModel(Model model, Principal principal)
org.springframework.http.ResponseEntity<CalculationData>	getCalculation(Model model, Integer scenarioNumber)
org.springframework.http.ResponseEntity<ScenarioComparison>	getComparison(Model model)
org.springframework.http.ResponseEntity<CalculationData>	getMetadata(Model model, Integer scenarioNumber)
void	initiateFormulas(Model model)
org.springframework.http.ResponseEntity<String>	lockModel(Model model, Principal principal)
org.springframework.http.ResponseEntity<String>	unlockModel(Model model, Principal principal)
org.springframework.http.ResponseEntity<String>	updateKeyParam(Model model, @Valid KeyParam keyParam, Principal principal)
org.springframework.http.ResponseEntity<String>	updateModel(Model model, @Valid ModelData modelData, Principal principal)

Methods inherited from class java.lang.Object

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

Field Details

MODEL_ID

public static final String MODEL_ID

See Also:

• Constant Field Values

MODEL_ID_DESCRIPTION

public static final String MODEL_ID_DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

ModelController

public ModelController(ModelRepository modelRepository,
 VariableRepository variableRepository,
 XLHandleManager xlHandleManager,
 EntityService entityService,
 UserRepository userRepository,
 Events events,
 EninAPIService eninAPIService,
 OpenAiServiceImplementation openAiServiceImplementation)

Initializes the model controller and establish link to database Creator function that ensures that the model is connected to a document

Method Details

cypress

@GetMapping("/api/cypress/{modelId}")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'READER\')")
public org.springframework.http.ResponseEntity<List<String>> cypress(@PathVariable("modelId")
 Model model)

Printing code for an entire model to use in FullModelTest

createModelFromEnin

@PostMapping("/api/modelenin")
public org.springframework.http.ResponseEntity<Long> createModelFromEnin(@RequestBody @Valid
 @Valid CompanyNameRecord companyNameRecord,
 @RequestParam
 Integer startYear,
 @RequestParam(defaultValue="Valuation model")
 String modelName,
 @RequestParam(defaultValue="false")
 boolean doImportGroupFigures,
 @RequestParam(defaultValue="1000")
 Integer unitDivider,
 Principal principal)

addModel

@PostMapping("/api/model")
@PreAuthorize("authentication.principal.hasAccessToTemplate(#templateId)")
public org.springframework.http.ResponseEntity<Long> addModel(@RequestBody @Valid
 @Valid ModelData modelData,
 @RequestParam(required=false,defaultValue="-1")
 Long templateId,
 @RequestParam(required=false,defaultValue="true")
 boolean copyVariableValues,
 Principal principal)

lockModel

@PatchMapping("/api/model/{modelId}/lock")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'ADMIN\')")
public org.springframework.http.ResponseEntity<String> lockModel(@PathVariable("modelId")
 Model model,
 Principal principal)

unlockModel

@PatchMapping("/api/model/{modelId}/unlock")
@PreAuthorize("authentication.principal.canUnlock(#model,\'ADMIN\')")
public org.springframework.http.ResponseEntity<String> unlockModel(@PathVariable("modelId")
 Model model,
 Principal principal)

updateModel

@PutMapping("/api/model/{modelId}")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'ADMIN\')")
public org.springframework.http.ResponseEntity<String> updateModel(@PathVariable("modelId")
 Model model,
 @RequestBody @Valid
 @Valid ModelData modelData,
 Principal principal)

initiateFormulas

public void initiateFormulas(Model model)

deleteModel

@DeleteMapping("/api/model/{modelId}")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'ADMIN\')")
public org.springframework.http.ResponseEntity<Void> deleteModel(@PathVariable("modelId")
 Model model,
 Principal principal)

updateKeyParam

@PutMapping("/api/model/{modelId}/keyparam")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'EDITOR\')")
public org.springframework.http.ResponseEntity<String> updateKeyParam(@PathVariable("modelId")
 Model model,
 @RequestBody @Valid
 @Valid KeyParam keyParam,
 Principal principal)

getMetadata

@GetMapping("/api/model/{modelId}/metadata")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'READER\')")
public org.springframework.http.ResponseEntity<CalculationData> getMetadata(@PathVariable("modelId")
 Model model,
 @RequestParam(defaultValue="0")
 Integer scenarioNumber)

Returns:

an object that contains all the metadata of the model

getCalculation

@GetMapping("/api/model/{modelId}/calculation")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'READER\')")
public org.springframework.http.ResponseEntity<CalculationData> getCalculation(@PathVariable("modelId")
 Model model,
 @RequestParam(defaultValue="0")
 Integer scenarioNumber)

Returns:

an object that contains all the processed data in the spreadsheet

debug

@GetMapping("/api/ping")
public String debug()

getComparison

@GetMapping("/api/model/{modelId}/comparison")
@PreAuthorize("authentication.principal.hasModelRole(#model,\'READER\')")
public org.springframework.http.ResponseEntity<ScenarioComparison> getComparison(@PathVariable("modelId")
 Model model)

Returns:

an object that contains all the data in the spreadsheet