Package overit.geocallapp.wfm.bundler.rs1.skill

Class BundleSkillService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.bundler.rs1.skill.BundleSkillService

@RestController
@RequestMapping("work-orders/bundler/r1/bundles/{bundleId:[0-9]+}/skills")
@Resource(logging=true)
public class BundleSkillService
extends PrivateService

Service to manage bundle skill.

Since:

21.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundleSkillService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOBundleSkill>	get(Long bundleId, Long bundleSkillId, Collection<String> fields)	Retrieves the required bundle skill by calling the BundleSkillLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOBundleSkill>>	getCollection(Long bundleId, @Valid Page page, Collection<String> fields, String order, @Valid DTOBundleSkillFilter filter)	Returns the collection of all the stored bundles skills by calling the BundleSkillSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

BundleSkillService

public BundleSkillService()

Method Details

getCollection

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

Returns the collection of all the stored bundles skills by calling the BundleSkillSearchEvent.

Parameters:

page - the page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

filter - the DTOBundleSkillFilter

Returns:

the collection of DTOBundleSkills

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required bundle skill by calling the BundleSkillLoadEvent.

Parameters:

bundleSkillId - the ID of the bundle skill to be loaded

fields - the collection of fields that will be contained in the response

Returns:

the response containing the bundle skill

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown