Package overit.geocallapp.wfm.core.rs5.material.history

Class MaterialHistoryService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.rs5.material.history.MaterialHistoryService

@RestController
@RequestMapping("core/r5/materials/histories")
@Resource(logging=true)
public class MaterialHistoryService
extends PrivateService

Services to manage material history.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MaterialHistoryService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMaterialHistory>	get(Long id, String language)	Retrieves the required DTOMaterialHistory by calling from the MaterialHistoryLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMaterialHistory>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOMaterialHistorySearchFilter filter)	Returns the collection of all the stored material histories by calling the MaterialHistorySearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

MaterialHistoryService

public MaterialHistoryService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOMaterialHistory>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOMaterialHistorySearchFilter filter)
                                                                                        throws DAValidateException,
DAException

Returns the collection of all the stored material histories by calling the MaterialHistorySearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOMaterialHistorySearchFilter

Returns:

the collection of DTOMaterialHistory

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOMaterialHistory by calling from the MaterialHistoryLoadEvent.

Parameters:

id - the material history id

language - the currently needed language

Returns:

the DTO response the loaded DTOMaterialHistory

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception