Package overit.geocallapp.wfm.materials.rs1.materialclass

Class MaterialClassService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.materials.rs1.materialclass.MaterialClassService

@RestController
@RequestMapping("inventory/materials/r1/classes")
@Resource(logging=true)
public class MaterialClassService
extends PrivateService

Services to manage material class.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MaterialClassService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMaterialClass>	get(Long id, Collection<String> fields, String language)	Retrieves the required DTOMaterialClass by calling from the MaterialClassLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMaterialClass>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid DTOMaterialClassSearchFilter filter)	Returns the collection of all the stored material classes by calling the MaterialClassSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOMaterialClassUpdate dto)	Updates the required material by calling the MaterialClassUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOMaterialClassInsert dto)	Creates a new material class by calling the MaterialClassInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

MaterialClassService

public MaterialClassService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOMaterialClass>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @RequestParam(required=false,name="_language",defaultValue="user")
 String language,
 @Valid
 @Valid DTOMaterialClassSearchFilter filter)
                                                                                      throws DAValidateException,
DAException

Returns the collection of all the stored material classes by calling the MaterialClassSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOMaterialClassSearchFilter

Returns:

the response containing the collection of DTOMaterialClass

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{classId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOMaterialClass> get(@PathVariable("classId")
 Long id,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_language",defaultValue="user")
 String language)
                                                              throws DAValidateException,
DAException

Retrieves the required DTOMaterialClass by calling from the MaterialClassLoadEvent.

Parameters:

id - the material class id

language - the currently needed language

Returns:

the response containing the loaded DTOMaterialClass

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOMaterialClassInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new material class by calling the MaterialClassInsertEvent.

Parameters:

dto - the DTOMaterialClassInsert containing the needed info

Returns:

the response containing the id of the inserted material class

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{classId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("classId")
 Long id,
 @Valid @RequestBody
 @Valid DTOMaterialClassUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required material by calling the MaterialClassUpdateEvent.

Parameters:

id - the material class id

dto - the DTOMaterialClassUpdate containing the needed info

Returns:

the update response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception