Package overit.geocallapp.wfm.projects.rs1.profile

Class ProjectProfileService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.profile.ProjectProfileService

@RestController
@RequestMapping("work-orders/projects/r1/project-profiles")
@Resource(logging=true)
public class ProjectProfileService
extends PrivateService

Services to manage project profile

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ProjectProfileService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOProjectProfile>	get(Long id, String language, Collection<String> fields)	Retrieves the required project profile by calling the ProjectProfileLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOProjectProfile>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOProjectProfileFilter filter)	Returns the collection of all the project profile by calling the ProjectProfileSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectProfileService

public ProjectProfileService()

Method Details

get

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

Retrieves the required project profile by calling the ProjectProfileLoadEvent.

Parameters:

id - project profile id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOProjectProfile

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

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

Returns the collection of all the project profile by calling the ProjectProfileSearchEvent.

Parameters:

page - the Page that will contain the paginated result

language - the user language

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOProjectProfileFilter

Returns:

the ResponseEntity containing the collection of DTOProjectProfile

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception