Package overit.geocallapp.docshare.documents.rs1.resourceorigin

Class ResourceOriginService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.docshare.documents.rs1.resourceorigin.ResourceOriginService

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

Service used to manage the resource origin.

Since:

14.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourceOriginService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOResourceOrigin>	get(Long originId, Collection<String> fields)	Retrieve the required resource origin by calling the SharedResourceOriginLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOResourceOrigin>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOResourceOriginFilter filter)	Retrieves the collection of all the stored resource origins by calling the SharedResourceOriginSearchEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceOriginService

public ResourceOriginService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOResourceOrigin>> 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 DTOResourceOriginFilter filter)
                                                                                       throws DAValidateException,
DAException

Retrieves the collection of all the stored resource origins by calling the SharedResourceOriginSearchEvent event

Parameters:

page - the page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

filter - the DTOResourceOriginFilter

Returns:

the collection of DTOResourceOrigins

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieve the required resource origin by calling the SharedResourceOriginLoadEvent event

Parameters:

originId - the resource origin id

fields - the collection of fields that will be contained in the response

Returns:

the DTOResourceOrigin

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception