Package overit.geocallapp.wfm.projects.rs1.type

Class ProjectTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.type.ProjectTypeService

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

Services to manage project type

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ProjectTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOProjectType>	get(Long id, String language, Collection<String> fields)	Retrieves the required project type.
org.springframework.http.ResponseEntity<PageResponse<DTOProjectType>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOProjectTypeFilter filter)	Retrieve the all stored project types.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectTypeService

public ProjectTypeService()

Method Details

get

@GetMapping(value="{projectTypeId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOProjectType> get(@PathVariable("projectTypeId")
 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 type. ProjectTypeLoadEvent

Parameters:

id - project type id

language - the user language

fields - the collection of fields the response will contain

Returns:

the response containing the required asset status

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

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

Retrieve the all stored project types. ProjectTypeSearchEvent

Parameters:

page - the required result page

language - the user language

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOProjectTypeFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception