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

Interface CategoryAPIs

public interface CategoryAPIs

Field Summary

Fields

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

Method Summary

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

Field Detail

CATEGORY

static final java.lang.String CATEGORY

See Also:

Constant Field Values

Method Detail

search

@GET("odata/Category")
CallX<java.util.List<Category>> 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 category 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 category entities

getAll

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

Get all category entities

Returns:

List of all category entities

create

@POST("odata/Category")
CallX<Category> create(@NotNull @Body
                       @NotNull Category category)

Create a new category entity

Parameters:

category - category entity

Returns:

created category entity

get

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

Get a category by id

Parameters:

key - category id

Returns:

List of categories that only contains one category entity or null if not found

delete

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

Delete a category by id

Parameters:

key - category id

Returns:

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