Package overit.geocallapp.wfm.workorders.rs1.note

Class WorkOrderNoteService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.note.WorkOrderNoteService

@RestController
@RequestMapping("work-orders/r1/notes")
@Resource(logging=true)
public class WorkOrderNoteService
extends PrivateService

Service to manage work order notes.

Since:

22.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderNoteService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkOrderNote>	get(Long noteId, String language, Collection<String> fields)	Retrieves a specific work order note by calling the WorkOrderNoteLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderNote>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTOWorkOrderNoteFilter filter)	Returns the collection of all the stored work order notes by calling the WorkOrderNoteSearchEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWorkOrderNoteInsert dto)	Creates a new work order note by calling the WorkOrderNoteInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkOrderNoteService

public WorkOrderNoteService()

Method Details

getCollection

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

Returns the collection of all the stored work order notes by calling the WorkOrderNoteSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

language - the language for multilanguage fields

filter - the DTOWorkOrderNoteFilter

Returns:

the collection of DTOWorkOrderNote

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves a specific work order note by calling the WorkOrderNoteLoadEvent.

Parameters:

noteId - the ID of the work order note to retrieve

language - the language for multilanguage fields

fields - the collection of fields that will be contained in the response

Returns:

the response containing the loaded work order note

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

post

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

Creates a new work order note by calling the WorkOrderNoteInsertEvent.

Parameters:

dto - the DTOWorkOrderNoteInsert

Returns:

the id of the created work order note

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown