Package overit.geocallapp.wfm.materials.rs1.item

Class MaterialItemService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.materials.rs1.item.MaterialItemService

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

Services to manage material item types.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MaterialItemService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMaterialItem>	get(Long id, Collection<String> fields, String language)	Retrieves the required DTOMaterialItem by calling from the MaterialItemLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMaterialItem>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid DTOMaterialItemSearchFilter filter)	Returns the collection of all the stored material item types by calling the MaterialItemSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOMaterialItemUpdate dto)	Updates the required material by calling the MaterialItemUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOMaterialItemInsert dto)	Creates a new item type by calling the MaterialItemInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

MaterialItemService

public MaterialItemService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOMaterialItem>> 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 DTOMaterialItemSearchFilter filter)
                                                                                     throws DAValidateException,
DAException

Returns the collection of all the stored material item types by calling the MaterialItemSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOMaterialItemSearchFilter

Returns:

the response containing the collection of DTOMaterialItem

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{itemId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOMaterialItem> get(@PathVariable("itemId")
 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 DTOMaterialItem by calling from the MaterialItemLoadEvent.

Parameters:

id - the item type id

Returns:

the response containing the loaded DTOMaterialItem

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 DTOMaterialItemInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new item type by calling the MaterialItemInsertEvent.

Parameters:

dto - the DTOMaterialItemInsert containing the needed info

Returns:

the response containing the id of the inserted item type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required material by calling the MaterialItemUpdateEvent.

Parameters:

id - the item type id

dto - the DTOMaterialItemUpdate containing the needed info

Returns:

the update response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception