Package overit.geocallapp.wfm.projects.rs1.activityrelation

Class ProjectActivityRelationService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.activityrelation.ProjectActivityRelationService

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

Services to manage project activity relation

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ProjectActivityRelationService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deletePredecessor(Long projectActivityId, Long predecessorRelationId)	Delete the project activity predecessor relation by calling the ProjectActivityRelationManagerEvent
org.springframework.http.ResponseEntity<Void>	deleteSuccessor(Long projectActivityId, Long successorRelationId)	Delete the project activity successor relation by calling the ProjectActivityRelationManagerEvent
org.springframework.http.ResponseEntity<DTOProjectActivityRelationPredecessor>	getPredecessor(Long projectActivityId, Long predecessorRelationId, String language, Collection<String> fields)	Retrieves the required project activity relation by calling the ProjectActivityRelationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOProjectActivityRelationPredecessor>>	getPredecessorCollection(Long projectActivityId, @Valid Page page, String language, Collection<String> fields, String order)	Returns the collection of all the project activity relations by calling the ProjectActivityRelationSearchEvent.
org.springframework.http.ResponseEntity<DTOProjectActivityRelationSuccessor>	getSuccessor(Long projectActivityId, Long successorRelationId, String language, Collection<String> fields)	Retrieves the required project activity relation by calling the ProjectActivityRelationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOProjectActivityRelationSuccessor>>	getSuccessorCollection(Long projectActivityId, @Valid Page page, String language, Collection<String> fields, String order)	Returns the collection of all the project activity relations by calling the ProjectActivityRelationSearchEvent.
org.springframework.http.ResponseEntity<Void>	patchPredecessor(Long projectActivityId, Long predecessorRelationId, @Valid DTOProjectActivityRelationPredecessorUpsert input)	Updates the required project activity relation by calling the ProjectActivityRelationManagerEvent.
org.springframework.http.ResponseEntity<Void>	patchSuccessor(Long projectActivityId, Long successorRelationId, @Valid DTOProjectActivityRelationSuccessorUpsert input)	Updates the required project activity relation by calling the ProjectActivityRelationManagerEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	postPredecessor(Long projectActivityId, @Valid DTOProjectActivityRelationPredecessorUpsert input)	Create a new project activity predecessor relation by calling the ProjectActivityRelationManagerEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	postSuccessor(Long projectActivityId, @Valid DTOProjectActivityRelationSuccessorUpsert input)	Create a new project activity successor relation by calling the ProjectActivityRelationManagerEvent

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectActivityRelationService

public ProjectActivityRelationService()

Method Details

postPredecessor

@PostMapping(path="{projectActivityId:[0-9]+}/predecessor-relations",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> postPredecessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @Valid @RequestBody
 @Valid DTOProjectActivityRelationPredecessorUpsert input)
                                                                             throws DAException,
DAValidateException

Create a new project activity predecessor relation by calling the ProjectActivityRelationManagerEvent

Parameters:

projectActivityId - the project activity id

input - the DTOProjectActivityRelationPredecessorUpsert

Returns:

the ResponseEntity containing the created project activity predecessor relation id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

postSuccessor

@PostMapping(path="{projectActivityId:[0-9]+}/successor-relations",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> postSuccessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @Valid @RequestBody
 @Valid DTOProjectActivityRelationSuccessorUpsert input)
                                                                           throws DAException,
DAValidateException

Create a new project activity successor relation by calling the ProjectActivityRelationManagerEvent

Parameters:

projectActivityId - the project activity id

input - the DTOProjectActivityRelationSuccessorUpsert

Returns:

the ResponseEntity containing the created project activity successor relation id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patchPredecessor

@PatchMapping(path="{projectActivityId:[0-9]+}/predecessor-relations/{predecessorRelationId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patchPredecessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @PathVariable("predecessorRelationId")
 Long predecessorRelationId,
 @Valid @RequestBody
 @Valid DTOProjectActivityRelationPredecessorUpsert input)
                                                               throws DAValidateException,
DAException

Updates the required project activity relation by calling the ProjectActivityRelationManagerEvent.

Parameters:

projectActivityId - the project activity id

predecessorRelationId - the project activity relation id

input - the DTOProjectActivityRelationPredecessorUpsert

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patchSuccessor

@PatchMapping(path="{projectActivityId:[0-9]+}/successor-relations/{successorRelationId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patchSuccessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @PathVariable("successorRelationId")
 Long successorRelationId,
 @Valid @RequestBody
 @Valid DTOProjectActivityRelationSuccessorUpsert input)
                                                             throws DAValidateException,
DAException

Updates the required project activity relation by calling the ProjectActivityRelationManagerEvent.

Parameters:

projectActivityId - the project activity id

successorRelationId - the project activity relation id

input - the DTOProjectActivityRelationSuccessorUpsert

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

deletePredecessor

@DeleteMapping(path="{projectActivityId:[0-9]+}/predecessor-relations/{predecessorRelationId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> deletePredecessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @PathVariable("predecessorRelationId")
 Long predecessorRelationId)
                                                                throws DAException,
DAValidateException

Delete the project activity predecessor relation by calling the ProjectActivityRelationManagerEvent

Parameters:

projectActivityId - the project activity id

predecessorRelationId - the project activity relation id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

deleteSuccessor

@DeleteMapping(path="{projectActivityId:[0-9]+}/successor-relations/{successorRelationId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> deleteSuccessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @PathVariable("successorRelationId")
 Long successorRelationId)
                                                              throws DAException,
DAValidateException

Delete the project activity successor relation by calling the ProjectActivityRelationManagerEvent

Parameters:

projectActivityId - the project activity id

successorRelationId - the project activity relation id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getPredecessor

@GetMapping(path="{projectActivityId:[0-9]+}/predecessor-relations/{predecessorRelationId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOProjectActivityRelationPredecessor> getPredecessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @PathVariable("predecessorRelationId")
 Long predecessorRelationId,
 @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 relation by calling the ProjectActivityRelationLoadEvent.

Parameters:

projectActivityId - the project activity id

predecessorRelationId - the project activity relation id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOProjectActivityRelationPredecessor

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getPredecessorCollection

@GetMapping(path="{projectActivityId:[0-9]+}/predecessor-relations",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOProjectActivityRelationPredecessor>> getPredecessorCollection(@PathVariable("projectActivityId")
 Long projectActivityId,
 @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)
                                                                                                                      throws DAValidateException,
DAException

Returns the collection of all the project activity relations by calling the ProjectActivityRelationSearchEvent.

Parameters:

projectActivityId - the project activity 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

Returns:

the ResponseEntity containing the collection of DTOProjectActivityRelationPredecessor

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getSuccessor

@GetMapping(path="{projectActivityId:[0-9]+}/successor-relations/{successorRelationId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOProjectActivityRelationSuccessor> getSuccessor(@PathVariable("projectActivityId")
 Long projectActivityId,
 @PathVariable("successorRelationId")
 Long successorRelationId,
 @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 relation by calling the ProjectActivityRelationLoadEvent.

Parameters:

projectActivityId - the project activity id

successorRelationId - the project activity relation id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOProjectActivityRelationSuccessor

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getSuccessorCollection

@GetMapping(path="{projectActivityId:[0-9]+}/successor-relations",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOProjectActivityRelationSuccessor>> getSuccessorCollection(@PathVariable("projectActivityId")
 Long projectActivityId,
 @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)
                                                                                                                  throws DAValidateException,
DAException

Returns the collection of all the project activity relations by calling the ProjectActivityRelationSearchEvent.

Parameters:

projectActivityId - the project activity 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

Returns:

the ResponseEntity containing the collection of DTOProjectActivityRelationSuccessor

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception