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 -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<DTODirectory> get(String directoryUuid, Collection<String> fields) Retrieve the required directory by calling theDirectoryLoadEvent.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 theDirectorySearchEvent.org.springframework.http.ResponseEntity<Void> patch(String directoryUuid, @Valid DTODirectoryUpdate dto) Updates the required directory by calling theDirectoryUpdateEvent.org.springframework.http.ResponseEntity<DTODirectoryKey> post(@Valid DTODirectoryInsert dto) Create a new directory by calling theDirectoryInsertEvent.
-
Constructor Details
-
DirectoryService
public DirectoryService()
-
-
Method Details
-
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 theDirectoryLoadEvent.- Parameters:
directoryUuid- the directory uuidfields- the collection of fields the response will contain- Returns:
- the response containing the loaded directory
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception