Package overit.geocallapp.wfm.projects.rs1.activity

Class ProjectsActivitiesService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.activity.ProjectsActivitiesService

@RestController
@Resource(logging=true)
@RequestMapping("work-orders/projects/r1/projects/{projectId:[0-9]+}/activities")
public class ProjectsActivitiesService
extends PrivateService

Services to manage project activity

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ProjectsActivitiesService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	cancellation(Long projectId, Long activityId)	Evolves in Cancel State the required project activity by calling the CancelProjectActivitiesEvent.
org.springframework.http.ResponseEntity<Void>	closure(Long projectId, Long activityId)	Evolves in Close State the required project activity by calling the CloseProjectActivitiesEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	createBelow(Long projectId, Long activityId, @Valid DTOProjectActivityInsert input)	Creates and add a new project activity below the one indicated
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	createNext(Long projectId, Long activityId, @Valid DTOProjectActivityInsert input)	Creates and add a new project activity next the one indicated
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	createPrevious(Long projectId, Long activityId, DTOProjectActivityInsert input)	Creates and add a new project activity before the one indicated
org.springframework.http.ResponseEntity<DTOProjectActivity>	get(Long projectId, Long projectActivityId, String language, Collection<String> fields)	Retrieves the required project activity by calling the ProjectActivityLoadEvent.
protected BOProjectActivity	getActivityDataToInsert(DTOProjectActivityInsert dto)
org.springframework.http.ResponseEntity<PageResponse<DTOProjectActivity>>	getCollection(Long projectId, @Valid Page page, String language, Collection<String> fields, String order, @Valid DTOProjectActivityFilter filter)	Returns the collection of all the project activity by calling the ProjectActivitySearchEvent.
protected BOProjectActivity	getCommonActivityData(DTOProjectActivityDebriefing dto)
protected BOProjectActivityDebriefing	getCommonDebriefingData(DTOProjectActivityDebriefing dto)
org.springframework.http.ResponseEntity<Void>	patch(Long projectId, Long projectActivityId, @Valid DTOProjectActivityUpdate input)	Updates the required project activity by calling the ModifyProjectActivityEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long projectId, @Valid DTOProjectActivityInsert input)	Create a new project activity by calling the AddProjectActivityEvent
org.springframework.http.ResponseEntity<Void>	release(Long projectId, Long activityId)	Evolves in Active State the required project activity by calling the ReleaseProjectActivitiesEvent.
org.springframework.http.ResponseEntity<Void>	technicalClose(Long projectId, Long activityId, @Valid DTOProjectActivityDebriefing dto)	Evolves in Technical Close State and save debriefing data the required project activity by calling the ProjectActivityGenericDebriefingCreateEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectsActivitiesService

public ProjectsActivitiesService()

Method Details

post

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

Create a new project activity by calling the AddProjectActivityEvent

Parameters:

projectId - the project id

input - the DTOProjectActivityInsert

Returns:

the ResponseEntity containing the created project activity 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("projectId")
 Long projectId,
 @PathVariable("id")
 Long projectActivityId,
 @Valid @RequestBody
 @Valid DTOProjectActivityUpdate input)
                                                    throws DAValidateException,
DAException

Updates the required project activity by calling the ModifyProjectActivityEvent.

Parameters:

projectId - the project id

projectActivityId - the project activity id

input - the DTOProjectActivityUpdate

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancellation

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

Evolves in Cancel State the required project activity by calling the CancelProjectActivitiesEvent.

Parameters:

projectId - the project id

activityId - the project activity id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

closure

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

Evolves in Close State the required project activity by calling the CloseProjectActivitiesEvent.

Parameters:

projectId - the project id

activityId - the project activity id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

release

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

Evolves in Active State the required project activity by calling the ReleaseProjectActivitiesEvent.

Parameters:

projectId - the project id

activityId - the project activity id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

technicalClose

@PostMapping(path="{activityId:[0-9]+}/technical-closures",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> technicalClose(@PathVariable("projectId")
 Long projectId,
 @PathVariable("activityId")
 Long activityId,
 @Valid @RequestBody
 @Valid DTOProjectActivityDebriefing dto)
                                                             throws DAException,
DAValidateException

Evolves in Technical Close State and save debriefing data the required project activity by calling the ProjectActivityGenericDebriefingCreateEvent.

Parameters:

projectId - the project id

activityId - the project activity id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required project activity by calling the ProjectActivityLoadEvent.

Parameters:

projectId - project id

projectActivityId - project activity id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOProjectActivity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOProjectActivity>> getCollection(@PathVariable("projectId")
 Long projectId,
 @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 DTOProjectActivityFilter filter)
                                                                                        throws DAValidateException,
DAException

Returns the collection of all the project activity by calling the ProjectActivitySearchEvent.

Parameters:

projectId - project id

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 DTOProjectActivityFilter

Returns:

the ResponseEntity containing the collection of DTOProjectActivity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createNext

@PostMapping(path="{activityId:[0-9]+}/next",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> createNext(@PathVariable("projectId")
 Long projectId,
 @PathVariable("activityId")
 Long activityId,
 @Valid @RequestBody
 @Valid DTOProjectActivityInsert input)
                                                                        throws DAException,
DAValidateException

Creates and add a new project activity next the one indicated

Parameters:

projectId - the project id

activityId - the project activity id

input - the DTOProjectActivityInsert

Returns:

the ResponseEntity containing the created project activity id

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

createPrevious

@PostMapping(path="{activityId:[0-9]+}/previous",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> createPrevious(@PathVariable("projectId")
 Long projectId,
 @PathVariable("activityId")
 Long activityId,
 @RequestBody
 DTOProjectActivityInsert input)
                                                                            throws DAException,
DAValidateException

Creates and add a new project activity before the one indicated

Parameters:

projectId - the project id

activityId - the project activity id

input - the DTOProjectActivityInsert

Returns:

the ResponseEntity containing the created project activity id

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

createBelow

@PostMapping(path="{activityId:[0-9]+}/below",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> createBelow(@PathVariable("projectId")
 Long projectId,
 @PathVariable("activityId")
 Long activityId,
 @Valid @RequestBody
 @Valid DTOProjectActivityInsert input)
                                                                         throws DAException,
DAValidateException

Creates and add a new project activity below the one indicated

Parameters:

projectId - the project id

activityId - the project activity id

input - the DTOProjectActivityInsert

Returns:

the ResponseEntity containing the created project activity id

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getCommonDebriefingData

protected BOProjectActivityDebriefing getCommonDebriefingData(DTOProjectActivityDebriefing dto)

getCommonActivityData

protected BOProjectActivity getCommonActivityData(DTOProjectActivityDebriefing dto)

getActivityDataToInsert

protected BOProjectActivity getActivityDataToInsert(DTOProjectActivityInsert dto)