Package overit.geocallapp.wfm.projects.rs1.header

Class ProjectsHeaderService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.header.ProjectsHeaderService

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

Services to manage project header

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ProjectsHeaderService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	cancellation(Long id)	Evolves in Cancelled State the required project header by calling the ProjectHeaderCancelEvent.
org.springframework.http.ResponseEntity<Void>	closure(Long id)	Evolves in Closed State the required project header by calling the ProjectHeaderCloseEvent.
org.springframework.http.ResponseEntity<DTOProjectHeader>	get(Long id, String language, Collection<String> fields)	Retrieves the required project header by calling the ProjectHeaderLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOProjectHeader>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOProjectHeaderFilter filter)	Returns the collection of all the project header by calling the ProjectHeaderSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOProjectHeaderUpdate dto)	Updates the required project header by calling the ProjectHeaderUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOProjectHeaderInsert input)	Create a new project header by calling the ProjectHeaderCreateEvent
org.springframework.http.ResponseEntity<Void>	release(Long id)	Evolves in Active State the required project header by calling the ProjectHeaderReleaseEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectsHeaderService

public ProjectsHeaderService()

Method Details

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOProjectHeaderInsert input)
                                                                  throws DAException,
DAValidateException

Create a new project header by calling the ProjectHeaderCreateEvent

Parameters:

input - the DTOProjectHeaderInsert

Returns:

the ResponseEntity containing the created project id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{id:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTOProjectHeaderUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required project header by calling the ProjectHeaderUpdateEvent.

Parameters:

id - the project header id

dto - the DTOProjectHeaderUpdate

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancellation

@PostMapping(value="{id:[0-9]+}/cancellations",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> cancellation(@PathVariable("id")
 Long id)
                                                           throws DAException,
DAValidateException

Evolves in Cancelled State the required project header by calling the ProjectHeaderCancelEvent.

Parameters:

id - the project header id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

closure

@PostMapping(value="{id:[0-9]+}/closures",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> closure(@PathVariable("id")
 Long id)
                                                      throws DAException,
DAValidateException

Evolves in Closed State the required project header by calling the ProjectHeaderCloseEvent.

Parameters:

id - the project header id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

release

@PostMapping(value="{id:[0-9]+}/releases",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> release(@PathVariable("id")
 Long id)
                                                      throws DAException,
DAValidateException

Evolves in Active State the required project header by calling the ProjectHeaderReleaseEvent.

Parameters:

id - the project header id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Parameters:

id - project id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOProjectHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

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

Returns the collection of all the project header by calling the ProjectHeaderSearchEvent.

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 DTOProjectHeaderFilter

Returns:

the ResponseEntity containing the collection of DTOProjectHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception