Package overit.geocallapp.wfm.execution.rs1.outcometype

Class OutcomeTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.outcometype.OutcomeTypeService

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

Service for manage outcome type.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OutcomeTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOOutcomeType>	get(Long outcomeTypeId, String language, Collection<String> fields)	Retrieves the required outcome type by calling from the OutcomeTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOOutcomeType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOOutcomeTypeFilter filter)	Returns the collection of all the stored outcome types by calling the OutcomeTypeSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

OutcomeTypeService

public OutcomeTypeService()

Method Details

getCollection

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

Returns the collection of all the stored outcome types by calling the OutcomeTypeSearchEvent.

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 DTOOutcomeTypeFilter

Returns:

the collection of outcome types

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required outcome type by calling from the OutcomeTypeLoadEvent.

Parameters:

outcomeTypeId - the outcome type id

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

Returns:

the response containing the loaded outcome type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception