Package overit.geocallapp.docshare.documents.rs1.metadata

Class ResourceMetadataService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.docshare.documents.rs1.metadata.ResourceMetadataService

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

Service used to manage the resource metadata.

Since:

14.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourceMetadataService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOResourceMetadata>	get(Long metadataId, Collection<String> fields)	Retrieves the required resource metadata by calling the SharedResourceMetadataLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOResourceMetadata>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOResourceMetadataFilter filter)	Returns the collection of all the stored resource metadata by calling the SharedResourceMetadataSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long sharedResourceMetadataId, @Valid DTOResourceMetadataUpdate dto)	Updates the required resource metadata by calling the SharedResourceMetadataUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOResourceMetadataInsert dto)	Creates a new resource metadata by calling the SharedResourceMetadataInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceMetadataService

public ResourceMetadataService()

Method Details

getCollection

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

Returns the collection of all the stored resource metadata by calling the SharedResourceMetadataSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOResourceMetadataFilter

Returns:

the collection of DTOResourceMetadata

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required resource metadata by calling the SharedResourceMetadataLoadEvent.

Parameters:

metadataId - the resource metadata id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded resource metadata

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

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

Creates a new resource metadata by calling the SharedResourceMetadataInsertEvent.

Parameters:

dto - the DTOResourceMetadataInsert containing the needed info

Returns:

the response containing the id of the inserted resource metadata

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required resource metadata by calling the SharedResourceMetadataUpdateEvent.

Parameters:

sharedResourceMetadataId - the resource metadata id

dto - the DTOResourceMetadataUpdate containing the needed info

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception