Package overit.geocallapp.wfm.teams.rs1.team

Class TeamService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.teams.rs1.team.TeamService

@RestController
@RequestMapping("workforce/teams/r1/teams")
@Resource(logging=true)
public class TeamService
extends PrivateService

Service to manage teams.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TeamService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOTeam>	get(Long teamId, Collection<String> fields)	Retrieves the required DTOTeam by calling from the TeamLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOTeam>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOTeamFilter filter)	Returns the collection of all the stored teams by calling the TeamSearchEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOTeamInsert dto)	Creates a new team by calling from the TeamInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

TeamService

public TeamService()

Method Details

getCollection

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

Returns the collection of all the stored teams by calling the TeamSearchEvent.

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 DTOTeamFilter

Returns:

the collection of DTOTeam

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOTeam by calling from the TeamLoadEvent.

Parameters:

teamId - the team id

fields - the collection of fields the response will contain

Returns:

the loaded DTOTeam

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 DTOTeamInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new team by calling from the TeamInsertEvent.

Parameters:

dto - the DTOTeamInsert containing the team data to insert

Returns:

the inserted team id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception