Package overit.geocallapp.docshare.documents.rs1.directory

Class DirectoryService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.docshare.documents.rs1.directory.DirectoryService

@RestController
@RequestMapping("documents/r1/directories")
@Resource(logging=true)
public class DirectoryService
extends PrivateService

Service to manage directories.

Since:

14.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
DirectoryService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTODirectory>	get(String directoryUuid, Collection<String> fields)	Retrieve the required directory by calling the DirectoryLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTODirectory>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTODirectoryFilter filter)	Retrieve the all stored directories by calling the DirectorySearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(String directoryUuid, @Valid DTODirectoryUpdate dto)	Updates the required directory by calling the DirectoryUpdateEvent.
org.springframework.http.ResponseEntity<DTODirectoryKey>	post(@Valid DTODirectoryInsert dto)	Create a new directory by calling the DirectoryInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryService

public DirectoryService()

Method Details

getCollection

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

Retrieve the all stored directories by calling the DirectorySearchEvent.

Parameters:

page - the required result page

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTODirectoryFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieve the required directory by calling the DirectoryLoadEvent.

Parameters:

directoryUuid - the directory uuid

fields - the collection of fields the response will contain

Returns:

the response containing the loaded directory

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTODirectoryKey> post(@Valid @RequestBody
 @Valid DTODirectoryInsert dto)
                                                              throws DAValidateException,
DAException

Create a new directory by calling the DirectoryInsertEvent.

Parameters:

dto - the DTODirectoryInsert

Returns:

the standard response containing the new directory id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{directoryUuid:[A-Za-z0-9-]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("directoryUuid")
 String directoryUuid,
 @Valid @RequestBody
 @Valid DTODirectoryUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required directory by calling the DirectoryUpdateEvent.

Parameters:

directoryUuid - the directory uuid

dto - the DTODirectoryUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception