Package overit.geocallapp.wfm.core.crewshell.rs1.crewshell.address

Class CrewShellAddressService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.crewshell.rs1.crewshell.address.CrewShellAddressService

@RestController
@RequestMapping("workforce/crew-shells/r1/crew-shells/{crewShellId:[0-9]+}/addresses")
@Resource(logging=true)
public class CrewShellAddressService
extends PrivateService

Services to manage BOCrewShellAddress objects.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CrewShellAddressService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long crewShell, Long id)	Deletes the required BOCrewShellAddress object by calling the CrewShellAddressDeleteEvent event.
org.springframework.http.ResponseEntity<DTOCrewShellAddress>	get(Long crewShell, Long id, Collection<String> fields)	Retrieves the required BOCrewShellAddress object by calling the CrewShellAddressLoadEvent event.
org.springframework.http.ResponseEntity<PageResponse<DTOCrewShellAddress>>	getCollection(@Valid Page page, Collection<String> fields, String order, Long crewShell, @Valid DTOCrewShellAddressFilter filter)	Retrieves the collection of all the stored BOCrewShellAddress objects by calling the CrewShellAddressSearchEvent event.
org.springframework.http.ResponseEntity<Void>	patch(Long crewShell, Long id, @Valid DTOCrewShellAddressUpdate dto)	Updates the required BOCrewShellAddress object by calling the CrewShellAddressUpdateEvent event.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long crewShell, @Valid DTOCrewShellAddressInsert dto)	Creates a new DTOCrewShellAddress object by calling the CrewShellAddressInsertEvent event.

Methods inherited from class java.lang.Object

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

Constructor Details

CrewShellAddressService

public CrewShellAddressService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOCrewShellAddress>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @PathVariable("crewShellId")
 Long crewShell,
 @Valid
 @Valid DTOCrewShellAddressFilter filter)
                                                                                         throws DAValidateException,
DAException

Retrieves the collection of all the stored BOCrewShellAddress objects by calling the CrewShellAddressSearchEvent event.

Parameters:

page - the Page object that will contain the paginated result

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

order - the ordering field

crewShell - the BOCrewShellAddress object's crewShell field

filter - the DTOCrewShellAddressFilter object

Returns:

the ResponseEntity object containing the collection of DTOCrewShellAddress objects

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

get

@GetMapping(value="{crewAddressId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOCrewShellAddress> get(@PathVariable("crewShellId")
 Long crewShell,
 @PathVariable("crewAddressId")
 Long id,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields)
                                                                 throws DAValidateException,
DAException

Retrieves the required BOCrewShellAddress object by calling the CrewShellAddressLoadEvent event.

Parameters:

crewShell - the BOCrewShellAddress object's crewShell field

id - the BOCrewShellAddress object's id field

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

Returns:

the ResponseEntity object containing the loaded DTOCrewShellAddress object

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

post

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

Creates a new DTOCrewShellAddress object by calling the CrewShellAddressInsertEvent event.

Parameters:

crewShell - the DTOCrewShellAddress object's crewShell field

dto - the DTOCrewShellAddressInsert object

Returns:

the ResponseEntity object containing the ID of the newly created BOCrewShellAddress object

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

patch

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

Updates the required BOCrewShellAddress object by calling the CrewShellAddressUpdateEvent event.

Parameters:

id - the BOCrewShellAddress object's id field

dto - the DTOCrewShellAddressUpdate object

Returns:

the ResponseEntity object

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

delete

@DeleteMapping(value="{crewAddressId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("crewShellId")
 Long crewShell,
 @PathVariable("crewAddressId")
 Long id)
                                                     throws DAValidateException,
DAException

Deletes the required BOCrewShellAddress object by calling the CrewShellAddressDeleteEvent event.

Parameters:

crewShell - the BOCrewShellAddress object's crewShell field

id - the id of the BOCrewShellAddress object to delete

Returns:

the ResponseEntity object

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown