Package overit.geocallapp.wfm.assets.rs1.asset

Class AssetService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.assets.rs1.asset.AssetService

@RestController
@RequestMapping("assets/r1/assets")
@Resource(logging=true)
public class AssetService
extends PrivateService

Service to manage assets.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AssetService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	batchInsertAssetChild(@Size(min=1,max=200) @Valid List<DTOAssetChildBatchInsert> batchInput)	Create a batch of asset children by calling the AssetChildInsertBatchEvent
org.springframework.http.ResponseEntity<Void>	batchPatch(@Size(min=1,max=200) @Valid List<DTOAssetBatchUpdate> batchInput)	Update a batch of assets by calling the AssetUpdateBatchEvent
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(@Size(min=1,max=200) @Valid List<DTOAssetInsert> batchInput)	Create a batch of assets by calling the AssetInsertBatchEvent
org.springframework.http.ResponseEntity<DTOAsset>	get(Long assetId, Collection<String> fields)	Retrieves the required DTOAsset by calling the AssetLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOAsset>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOAssetFilter filter)	Returns the collection of all the stored assets by calling the AssetSearchEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOAssetDescendant>>	getDescendant(Long assetId, @Valid Page page, Collection<String> fields, String order, @Valid DTOAssetDescendantFilter filter)	Returns the collection of all the stored descendant assets by calling the AssetDescendantSearchEvent.
org.springframework.http.ResponseEntity<Void>	insertAssetChild(Long assetId, @Valid DTOAssetChildInsert dto)	Inserts a new child for a given asset by calling the AssetChildInsertEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long assetId, @Valid DTOAssetUpdate dto)	Update an asset by calling the AssetUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOAssetInsert dto)	Create a new asset by calling the AssetInsertEvent
org.springframework.http.ResponseEntity<Void>	removeAssetChild(Long assetId, Long assetChildId)	Remove a parent for a given asset by calling the AssetChildRemoveEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

AssetService

public AssetService()

Method Details

getCollection

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

Returns the collection of all the stored assets by calling the AssetSearchEvent.

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 DTOAssetFilter

Returns:

the collection of DTOAsset

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOAsset by calling the AssetLoadEvent.

Parameters:

assetId - the asset id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded asset

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

insertAssetChild

@PostMapping(consumes="application/json",
             produces="application/json",
             path="/{assetId:[0-9]+}/children")
public org.springframework.http.ResponseEntity<Void> insertAssetChild(@PathVariable("assetId")
 Long assetId,
 @Valid @RequestBody
 @Valid DTOAssetChildInsert dto)
                                                               throws DAValidateException,
DAException

Inserts a new child for a given asset by calling the AssetChildInsertEvent.

Parameters:

assetId - the asset id

dto - the DTOAssetChildInsert

Returns:

the standard response

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 DTOAssetInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new asset by calling the AssetInsertEvent

Parameters:

dto - the DTOAssetInsert

Returns:

the standard response containing the new asset id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

removeAssetChild

@DeleteMapping(path="/{assetId:[0-9]+}/children/{assetChildId:[0-9]+}")
public org.springframework.http.ResponseEntity<Void> removeAssetChild(@PathVariable("assetId")
 Long assetId,
 @PathVariable("assetChildId")
 Long assetChildId)
                                                               throws DAValidateException,
DAException

Remove a parent for a given asset by calling the AssetChildRemoveEvent.

Parameters:

assetId - the asset id

assetChildId - the asset child id

Returns:

the empty response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update an asset by calling the AssetUpdateEvent

Parameters:

assetId - the asset id

dto - the DTOAssetUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchInsertAssetChild

@PostMapping(consumes="application/json",
             produces="application/json",
             path="/children/batch")
public org.springframework.http.ResponseEntity<Void> batchInsertAssetChild(@Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOAssetChildBatchInsert> batchInput)
                                                                    throws DAValidateException,
DAException

Create a batch of asset children by calling the AssetChildInsertBatchEvent

Parameters:

batchInput - a list of DTOAssetChildBatchInsert

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPatch

@PatchMapping(value="/batch",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchPatch(@Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOAssetBatchUpdate> batchInput)
                                                         throws DAValidateException,
DAException

Update a batch of assets by calling the AssetUpdateBatchEvent

Parameters:

batchInput - a list of DTOAssetBatchUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOAssetInsert> batchInput)
                                                                             throws DAValidateException,
DAException

Create a batch of assets by calling the AssetInsertBatchEvent

Parameters:

batchInput - a list of DTOAssetInsert

Returns:

the standard response containing the list of new assets ids

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getDescendant

@GetMapping(value="/{assetId:[0-9]+}/descendants",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOAssetDescendant>> getDescendant(@PathVariable("assetId")
 Long assetId,
 @RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields,
 @RequestParam(required=false,value="_order")
 String order,
 @Valid
 @Valid DTOAssetDescendantFilter filter)
                                                                                        throws DAValidateException,
DAException

Returns the collection of all the stored descendant assets by calling the AssetDescendantSearchEvent.

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 DTOAssetDescendantFilter

Returns:

the collection of DTOAsset

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception