Package org.cswteams.ms3.control.requestRemovalFromConcreteShift

Interface IRequestRemovalFromConcreteShiftController

All Known Implementing Classes:

RequestRemovalFromConcreteShiftController

public interface IRequestRemovalFromConcreteShiftController

Method Summary

Modifier and Type	Method	Description
RequestRemovalFromConcreteShiftDTO	createRequest(RequestRemovalFromConcreteShiftDTO requestRemovalFromConcreteShiftDTO)	Create a new request of removal from concrete shift, given a DTO.
Set<RequestRemovalFromConcreteShiftDTO>	getAllRequests()	Get all the requests from the database.
Set<RequestRemovalFromConcreteShiftDTO>	getPendingRequests()	Get all pending requests (i.e. not reviewed).
RequestRemovalFromConcreteShiftDTO	getRequest(Long requestId)	Get a specific request, given an ID.
Set<RequestRemovalFromConcreteShiftDTO>	getRequestsByRequestingDoctorId(Long requestingDoctorId)	Get all the requests, filtered by requesting doctor ID.
RequestRemovalFromConcreteShiftDTO	reviewRequest(RequestRemovalFromConcreteShiftDTO requestRemovalFromConcreteShiftDTO)	Review a request (done by a Planner - the outcome is embedded into the DTO parameter).
RequestRemovalFromConcreteShiftDTO	uploadFile(@NotNull Long requestId, @NotNull org.springframework.web.multipart.MultipartFile file)	Upload a file (not mandatory) to be attached to a request, given the request ID.

Method Details

createRequest

RequestRemovalFromConcreteShiftDTO createRequest(RequestRemovalFromConcreteShiftDTO requestRemovalFromConcreteShiftDTO)
                                          throws DatabaseException,
ConcreteShiftException

Create a new request of removal from concrete shift, given a DTO.

Parameters:

requestRemovalFromConcreteShiftDTO - DTO related to the request

Returns:

DTO object related to the request

Throws:

DatabaseException - in case an error during database lookup occurs

ConcreteShiftException - in case an error during database lookup occurs

getRequest

RequestRemovalFromConcreteShiftDTO getRequest(Long requestId)
                                       throws DatabaseException

Get a specific request, given an ID.

Parameters:

requestId - request id

Returns:

object related to the request, if any

Throws:

DatabaseException - in case an error during database lookup occurs

getAllRequests

Set<RequestRemovalFromConcreteShiftDTO> getAllRequests()

Get all the requests from the database.

Returns:

Set of all the requests from the database

getPendingRequests

Set<RequestRemovalFromConcreteShiftDTO> getPendingRequests()

Get all pending requests (i.e. not reviewed).

Returns:

Set of all the pending requests from the database

getRequestsByRequestingDoctorId

Set<RequestRemovalFromConcreteShiftDTO> getRequestsByRequestingDoctorId(Long requestingDoctorId)

Get all the requests, filtered by requesting doctor ID.

Parameters:

requestingDoctorId - requesting doctor ID, for filtering

Returns:

Set of all the requests related to the specific doctor whose ID is provided

reviewRequest

RequestRemovalFromConcreteShiftDTO reviewRequest(RequestRemovalFromConcreteShiftDTO requestRemovalFromConcreteShiftDTO)
                                          throws DatabaseException,
ConcreteShiftException

Review a request (done by a Planner - the outcome is embedded into the DTO parameter).

Parameters:

requestRemovalFromConcreteShiftDTO - DTO related to the request

Returns:

DTO related to the request, updated with the outcome of the review

Throws:

DatabaseException - in case an error during database lookup occurs

ConcreteShiftException

uploadFile

RequestRemovalFromConcreteShiftDTO uploadFile(@NotNull
 @NotNull Long requestId,
 @NotNull
 @NotNull org.springframework.web.multipart.MultipartFile file)
                                       throws IOException,
DatabaseException

Upload a file (not mandatory) to be attached to a request, given the request ID.

Parameters:

requestId - request id

file - file to be attached

Returns:

DTO related to the request, updated with the file

Throws:

IOException - in case of I/O errors

DatabaseException - in case an error during database lookup occurs