Package overit.geocallapp.wfm.core.rs5.workorder.attachment

Class WorkOrderAttachmentService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.rs5.workorder.attachment.WorkOrderAttachmentService

@RestController
@RequestMapping("core/r5/workorders/{id}/attachments")
@Resource(logging=true)
public class WorkOrderAttachmentService
extends PrivateService

Services to manage work orders attachments

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderAttachmentService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderAttachment>>	getCollection(Long id)	Retrieve all the attachments linked with the work order WorkOrderHeaderSearchEvent
org.springframework.http.ResponseEntity<DTOWorkOrderAttachment>	post(Long id, @Valid DTOWorkOrderAttachmentInsert dtoWokOrderAttachmentInsert)	Add an attachment to the work order WorkOrderAttachmentInsertEvent.
org.springframework.http.ResponseEntity<Void>	remove(Long id, String uuid)	Action to remove an attachment WorkOrderAttachmentRemoveEvent.
org.springframework.http.ResponseEntity<DTOWorkOrderAttachment>	uploadOutcome(Long id, @Valid DTOWorkOrderAttachmentUploadOutcome dtoWorkOrderAttachmentComplete)	Action to upload the outcome of a work order attachment association WorkOrderAttachmentUploadOutcomeEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkOrderAttachmentService

public WorkOrderAttachmentService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderAttachment>> getCollection(@PathVariable("id")
 Long id)
                                                                                            throws DAValidateException,
DAException

Retrieve all the attachments linked with the work order WorkOrderHeaderSearchEvent

Parameters:

id - the workorder id

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOWorkOrderAttachment> post(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTOWorkOrderAttachmentInsert dtoWokOrderAttachmentInsert)
                                                                     throws DAException,
DAValidateException

Add an attachment to the work order WorkOrderAttachmentInsertEvent.

Parameters:

id - the id of the work order to associate with the attachment

dtoWokOrderAttachmentInsert - the DTOWorkOrderAttachmentInsert mapping the data of the work order attachment to insert

Returns:

the DTO response containing the new workorder attachment id

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

uploadOutcome

@PostMapping(value="actions/uploadOutcome",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOWorkOrderAttachment> uploadOutcome(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTOWorkOrderAttachmentUploadOutcome dtoWorkOrderAttachmentComplete)
                                                                              throws DAException,
DAValidateException

Action to upload the outcome of a work order attachment association WorkOrderAttachmentUploadOutcomeEvent.

Parameters:

id - the id of the work order to close

dtoWorkOrderAttachmentComplete - the DTOWorkOrderAttachmentUploadOutcome of the resource to complete

Returns:

the DTO response containing the workorder attachment

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

remove

@PostMapping(value="actions/remove/{uuid}",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> remove(@PathVariable("id")
 Long id,
 @PathVariable("uuid")
 String uuid)
                                                     throws DAException,
DAValidateException

Action to remove an attachment WorkOrderAttachmentRemoveEvent.

Parameters:

id - the id of the work order

uuid - the uuid of the resource to delete

Returns:

the DTO response

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception