Package overit.geocallapp.wfm.projects.rs1.status

Class ProjectStatusService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.status.ProjectStatusService

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

Services to manage project status

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ProjectStatusService()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectStatusService

public ProjectStatusService()

Method Details

get

@GetMapping(value="{projectStatusId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOProjectStatus> get(@PathVariable("projectStatusId")
 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 status by calling the ProjectStatusLoadEvent.

Parameters:

id - project status id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOProjectStatus

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOProjectStatus>> 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 DTOProjectStatusFilter filter)
                                                                                      throws DAValidateException,
DAException

Returns the collection of all the project status by calling the ProjectStatusSearchEvent.

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 DTOProjectStatusFilter

Returns:

the ResponseEntity containing the collection of DTOProjectStatus

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception