Package overit.geocallapp.wfm.organizationalstructures.rs1.structurevalidityperiod

Class StructureValidityPeriodService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.organizationalstructures.rs1.structurevalidityperiod.StructureValidityPeriodService

@RestController
@RequestMapping("territory/organizational-structures/r1/structures/{structureId:[0-9]+}/validity-period")
@Resource(logging=true)
public class StructureValidityPeriodService
extends PrivateService

Service for manage structure validity period

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
StructureValidityPeriodService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long structureId, Long structureValidityPeriodId)	Delete the required structure validity period.
org.springframework.http.ResponseEntity<DTOStructureValidityPeriod>	get(Long structureId, Long structureValidityPeriodId, Collection<String> fields)	Retrieves the required DTOStructureValidityPeriod by calling the StructureValidityPeriodLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOStructureValidityPeriod>>	getCollection(Long structureId, @Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOStructureValidityPeriodFilter filter)	Returns the collection of all the stored structure validity periods by calling the StructureValidityPeriodSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long structureId, Long structureValidityPeriodId, @Valid DTOStructureValidityPeriodUpdate dto)	Update an structure validity period by calling the StructureValidityPeriodUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long structureId, @Valid DTOStructureValidityPeriodInsert dto)	Create a new structure validity period by calling the StructureValidityPeriodInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

StructureValidityPeriodService

public StructureValidityPeriodService()

Method Details

getCollection

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

Returns the collection of all the stored structure validity periods by calling the StructureValidityPeriodSearchEvent.

Parameters:

structureId -

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOStructureValidityPeriodFilter

Returns:

the collection of DTOStructureValidityPeriod

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOStructureValidityPeriod by calling the StructureValidityPeriodLoadEvent.

Parameters:

structureId - the structure id

structureValidityPeriodId - the structure validity period id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded account

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

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

Create a new structure validity period by calling the StructureValidityPeriodInsertEvent

Parameters:

structureId - structure id

dto - the DTOStructureValidityPeriodInsert

Returns:

the standard response containing the new account id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update an structure validity period by calling the StructureValidityPeriodUpdateEvent

Parameters:

structureId - structure id

structureValidityPeriodId - structure validity period id

dto - the DTOStructureValidityPeriodUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Delete the required structure validity period. StructureValidityPeriodDeleteEvent

Parameters:

structureId - the structure id

structureValidityPeriodId - the structure validity period id

Returns:

the response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception