com.sdl.delivery.ugc.client

Interface UgcClientApi

public interface UgcClientApi

Ugc client api define the api which one ugc client should provide implementation (mainly CRUD operations).

Method Summary

Modifier and Type	Method and Description
Object	createEntity(Object entity) Create new entity.
List<?>	getEntities(com.sdl.odata.client.api.ODataClientQuery clientQuery) Gets all entities of a specific entity type recognized by query.
Object	getEntity(com.sdl.odata.client.api.ODataClientQuery clientQuery) Get the entity recognized by query.
void	removeEntity(com.sdl.odata.client.api.model.ODataIdAwareEntity entity) Remove existing entity.
Object	updateEntity(com.sdl.odata.client.api.model.ODataIdAwareEntity entity) Update existing entity.

Method Detail

getEntities

List<?> getEntities(com.sdl.odata.client.api.ODataClientQuery clientQuery)

Gets all entities of a specific entity type recognized by query.

Parameters:

clientQuery - the query to oData service

Returns:

all entities that satisfy provided query

getEntity

Object getEntity(com.sdl.odata.client.api.ODataClientQuery clientQuery)

Get the entity recognized by query.

Parameters:

clientQuery - the query to oData service

Returns:

entity that satisfy provided query

createEntity

Object createEntity(Object entity)

Create new entity.

Parameters:

entity - the entity that has to be created

Returns:

the created entity

updateEntity

Object updateEntity(com.sdl.odata.client.api.model.ODataIdAwareEntity entity)

Update existing entity.

Parameters:

entity - the entity which should be updated

Returns:

the updated entity

removeEntity

void removeEntity(com.sdl.odata.client.api.model.ODataIdAwareEntity entity)

Remove existing entity.

Parameters:

entity - the entity which should be removed