Package org.dynamoframework.rest.model

Class EntityModelController

java.lang.Object

org.dynamoframework.rest.model.EntityModelController

@RestController
@RequestMapping("#{@\'dynamoframework-org.dynamoframework.configuration.DynamoConfigurationProperties\'.defaults.endpoints.model}")
@CrossOrigin
public class EntityModelController
extends Object

Constructor Summary

Constructors

Constructor	Description
EntityModelController()

Method Summary

Modifier and Type	Method	Description
EntityModelResponse	getActionEntityModel(String entityName, String actionId, String reference)	Retrieves a nested entity model based on the main attribute name and the name of the attribute
EntityModelResponse	getEntityModel(String entityName, String reference)	Retrieves an entity model based on the name of the entity
EntityModelResponse	getNestedEntityModel(String entityName, String attributeName, String reference)	Retrieves a nested entity model based on entity name and the name of the attribute
EntityModelResponse	getNestedEntityModel2(String entityName, String attributeName, String secondAttribute, String reference)	Retrieves a nested entity model based on entity name and two nested attributes

Methods inherited from class java.lang.Object

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

Constructor Details

EntityModelController

public EntityModelController()

Method Details

getEntityModel

@GetMapping("/{entityName}")
public EntityModelResponse getEntityModel(@PathVariable
 String entityName,
 @RequestParam(required=false)
 String reference)

Retrieves an entity model based on the name of the entity

Parameters:

entityName - the name of the entity

reference - optional reference to the specific entity model

Returns:

the entity model

getNestedEntityModel

@GetMapping("/{entityName}/attribute/{attributeName}")
public EntityModelResponse getNestedEntityModel(@PathVariable
 String entityName,
 @PathVariable
 String attributeName,
 @RequestParam(required=false)
 String reference)

Retrieves a nested entity model based on entity name and the name of the attribute

Parameters:

entityName - the entity name

attributeName - the name of the attribute

Returns:

the entity model

getNestedEntityModel2

@GetMapping("/{entityName}/attribute/{attributeName}/attribute/{secondAttribute}")
public EntityModelResponse getNestedEntityModel2(@PathVariable
 String entityName,
 @PathVariable
 String attributeName,
 @PathVariable
 String secondAttribute,
 @RequestParam(required=false)
 String reference)

Retrieves a nested entity model based on entity name and two nested attributes

Parameters:

entityName - the main entity name

attributeName - the name of the attribute

Returns:

the entity model

getActionEntityModel

@GetMapping("/{entityName}/action/{actionId}")
public EntityModelResponse getActionEntityModel(@PathVariable
 String entityName,
 @PathVariable
 String actionId,
 @RequestParam(required=false)
 String reference)

Retrieves a nested entity model based on the main attribute name and the name of the attribute

Parameters:

entityName - the main entity name

actionId - the ID of the action

Returns:

the entity model