Package overit.geocallapp.wfm.teams.rs1.teamtypes

Class TeamTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.teams.rs1.teamtypes.TeamTypeService

@RestController
@RequestMapping("workforce/teams/r1/team-types")
@Resource(logging=true)
public class TeamTypeService
extends PrivateService

Service to manage team type

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TeamTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOTeamType>	get(Long id, Collection<String> fields)	Retrieves the required DTOTeamType by calling the TeamTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOTeamType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOTeamTypeFilter filter)	Returns the collection of all the stored team typ[e by calling the TeamTypeSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOTeamTypeUpdate dto)	Update a team type by calling the TeamTypeUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOTeamTypeInsert dto)	Create a new team type by calling the TeamTypeInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

TeamTypeService

public TeamTypeService()

Method Details

getCollection

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

Returns the collection of all the stored team typ[e by calling the TeamTypeSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOTeamTypeFilter

Returns:

the collection of DTOTeamType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOTeamType by calling the TeamTypeLoadEvent.

Parameters:

id - the team type id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded team type

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(@Valid @RequestBody
 @Valid DTOTeamTypeInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new team type by calling the TeamTypeInsertEvent

Parameters:

dto - the DTOTeamTypeInsert

Returns:

the standard response containing the new team type id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a team type by calling the TeamTypeUpdateEvent

Parameters:

id - the team type id

dto - the DTOTeamTypeUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception