com.licensespring.management.dto.request

Class SearchProductsRequest.SearchProductsRequestBuilder

java.lang.Object

com.licensespring.management.dto.request.SearchProductsRequest.SearchProductsRequestBuilder

Enclosing class:

SearchProductsRequest

public static class SearchProductsRequest.SearchProductsRequestBuilder
extends Object

The SearchProductsRequest builder.

Method Summary

Modifier and Type	Method and Description
SearchProductsRequest	build()
SearchProductsRequest.SearchProductsRequestBuilder	isArchived(boolean isArchived) Indicates if the products that are searched for are archived or not.
SearchProductsRequest.SearchProductsRequestBuilder	limit(Integer limit) Number of results you want to be shown.
SearchProductsRequest.SearchProductsRequestBuilder	metadata(com.google.gson.JsonElement metadata) A JSON element containing additional metadata information for filtering products.
SearchProductsRequest.SearchProductsRequestBuilder	offset(Integer offset) The initial index from which to return the results.
SearchProductsRequest.SearchProductsRequestBuilder	orderBy(String orderBy) The result of the queries is a list that can than be ordered in ascending order by some attribute.
SearchProductsRequest.SearchProductsRequestBuilder	sortDescending(boolean sortDescending) Indicates if the results of the queries should be ordered in descending order.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

limit

public SearchProductsRequest.SearchProductsRequestBuilder limit(Integer limit)

Number of results you want to be shown. Server sends paginated response that's why limit can be set. Default is 20.

Returns:

this.

offset

public SearchProductsRequest.SearchProductsRequestBuilder offset(Integer offset)

The initial index from which to return the results. Server sends paginated response that's why offset can be set.

Returns:

this.

orderBy

public SearchProductsRequest.SearchProductsRequestBuilder orderBy(String orderBy)

The result of the queries is a list that can than be ordered in ascending order by some attribute. This is where that attribute needs to be set. Currently only is_archived is available.

Returns:

this.

isArchived

public SearchProductsRequest.SearchProductsRequestBuilder isArchived(boolean isArchived)

Indicates if the products that are searched for are archived or not. Default is false.

Returns:

this.

metadata

public SearchProductsRequest.SearchProductsRequestBuilder metadata(com.google.gson.JsonElement metadata)

A JSON element containing additional metadata information for filtering products.

Returns:

this.

sortDescending

public SearchProductsRequest.SearchProductsRequestBuilder sortDescending(boolean sortDescending)

Indicates if the results of the queries should be ordered in descending order. Default order is ascending, and default value of this field is therefore false.

Returns:

this.

build

public SearchProductsRequest build()

toString

public String toString()

Overrides:

toString in class Object