Package overit.geocallapp.wfm.materials.rs1.type

Class MaterialTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.materials.rs1.type.MaterialTypeService

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

Services to manage material types.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MaterialTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMaterialType>	get(Long id, Collection<String> fields)	Retrieves the required DTOMaterialType by calling from the MaterialTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMaterialType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOMaterialTypeSearchFilter filter)	Returns the collection of all the stored material types by calling the MaterialTypeSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

MaterialTypeService

public MaterialTypeService()

Method Details

getCollection

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

Returns the collection of all the stored material types by calling the MaterialTypeSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOMaterialTypeSearchFilter

Returns:

the response containing the collection of DTOMaterialType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOMaterialType by calling from the MaterialTypeLoadEvent.

Parameters:

id - the type id

Returns:

the response containing the loaded DTOMaterialType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception