Package overit.geocallapp.wfm.execution.rs1.outcomeclass

Class OutcomeClassService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.outcomeclass.OutcomeClassService

@RestController
@RequestMapping("work-orders/execution/r1/outcome-classes")
@Resource(logging=true)
public class OutcomeClassService
extends PrivateService

Service for manage outcome class.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OutcomeClassService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOOutcomeClass>	get(Long outcomeClassId, Collection<String> fields)	Retrieves the required outcome class by calling from the OutcomeClassLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOOutcomeClass>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOOutcomeClassFilter filter)	Returns the collection of all the stored outcome classes by calling the OutcomeClassSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

OutcomeClassService

public OutcomeClassService()

Method Details

getCollection

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

Returns the collection of all the stored outcome classes by calling the OutcomeClassSearchEvent.

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 DTOOutcomeClassFilter

Returns:

the collection of outcome classes

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required outcome class by calling from the OutcomeClassLoadEvent.

Parameters:

outcomeClassId - the outcome class id

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

Returns:

the response containing the loaded outcome class

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception