Package overit.geocallapp.wfm.teams.rs1.teammember

Class TeamMemberService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.teams.rs1.teammember.TeamMemberService

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

Service to manage team member

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TeamMemberService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOTeamMember>	get(Long id, Collection<String> fields)	Retrieves the required DTOTeamMember by calling the TeamMemberLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOTeamMember>>	getCollection(@Valid Page page, Collection<String> fields, String order, DTOTeamMemberFilter filter)	Returns the collection of all the stored team member by calling the TeamMemberSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOTeamMemberUpdate dto)	Update a team member by calling the TeamMemberUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOTeamMemberInsert dto)	Create a new team member by calling the TeamMemberInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

TeamMemberService

public TeamMemberService()

Method Details

getCollection

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

Returns the collection of all the stored team member by calling the TeamMemberSearchEvent.

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 DTOTeamMemberFilter

Returns:

the collection of DTOTeamMember

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOTeamMember by calling the TeamMemberLoadEvent.

Parameters:

id - the team member id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded team member

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

Create a new team member by calling the TeamMemberInsertEvent

Parameters:

dto - the DTOTeamMemberInsert

Returns:

the standard response containing the new team member id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a team member by calling the TeamMemberUpdateEvent

Parameters:

id - the team member id

dto - the DTOTeamMemberUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception