Package io.githhub.TradersTeam.grand_node_java_client.network.apis

Interface BrandAPIs

public interface BrandAPIs

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BRAND

Method Summary

Modifier and Type	Method	Description
CallX<Brand>	create(@NotNull Brand brand)	Create a new brand entity
CallX<java.lang.Void>	delete(@NotNull java.lang.String key)	Delete a brand by id
CallX<java.util.List<Brand>>	get(@NotNull java.lang.String key)	Get a brand by id
default CallX<java.util.List<Brand>>	getAll()	Get all brand entities
CallX<java.util.List<Brand>>	search(java.lang.Integer top, java.lang.Integer skip, java.lang.Boolean count, java.lang.String orderBy, java.lang.String filter)	Search brand entities by query parameters
CallX<Brand>	update(@NotNull Brand brand)	Update a brand

Field Detail

BRAND

static final java.lang.String BRAND

See Also:

Constant Field Values

Method Detail

search

@GET("odata/Brand")
CallX<java.util.List<Brand>> search(@Query("$top")
                                    java.lang.Integer top,
                                    @Query("$skip")
                                    java.lang.Integer skip,
                                    @Query("$count")
                                    java.lang.Boolean count,
                                    @Query("$orderby")
                                    java.lang.String orderBy,
                                    @Query("$filter")
                                    java.lang.String filter)

Search brand entities by query parameters

Parameters:

top - Show only the first n items.

skip - Skip the first n items.

count - Include count of items

orderBy - Order items by property values

filter - Filter items by property values

Returns:

List of brand entities

getAll

default CallX<java.util.List<Brand>> getAll()

Get all brand entities

Returns:

List of all brand entities

create

@POST("odata/Brand")
CallX<Brand> create(@NotNull @Body
                    @NotNull Brand brand)

Create a new brand entity

Parameters:

brand - brand entity

Returns:

created brand entity

get

@GET("odata/Brand/{key}")
CallX<java.util.List<Brand>> get(@NotNull @Path("key")
                                 @NotNull java.lang.String key)

Get a brand by id

Parameters:

key - brand id

Returns:

List of brands that only contains one brand entity or null if not found

delete

@DELETE("odata/Brand")
CallX<java.lang.Void> delete(@NotNull @Query("key")
                             @NotNull java.lang.String key)

Delete a brand by id

Parameters:

key - brand id

Returns:

If the brand was found and deleted HTTP response code is 200 and if the brand was not found HTTP response code is 404

update

@PUT("odata/Brand")
CallX<Brand> update(@NotNull @Body
                    @NotNull Brand brand)

Update a brand

Parameters:

brand - brand entity

Returns:

updated brand entity