com.licensespring.management.dto.request

Class SearchProductsRequest

java.lang.Object

com.licensespring.management.dto.request.SearchProductsRequest

public final class SearchProductsRequest
extends Object

Data transfer object that is used for searching through products APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchProductsRequest.SearchProductsRequestBuilder The SearchProductsRequest builder.

Method Summary

Modifier and Type	Method and Description
static SearchProductsRequest.SearchProductsRequestBuilder	builder() Use this builder to construct the search request.
boolean	equals(Object o)
Integer	getLimit() Number of results you want to be shown.
Integer	getOffset() The initial index from which to return the results.
String	getOrderBy() The result of the queries is a list that can than be ordered in ascending order by some attribute.
int	hashCode()
boolean	isArchived() Indicates if the products that are searched for are archived or not.
boolean	isSortDescending() Indicates if the results of the queries should be ordered in descending order.
SearchProductsRequest.SearchProductsRequestBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static SearchProductsRequest.SearchProductsRequestBuilder builder()

Use this builder to construct the search request.

Returns:

the builder for the SearchProductsRequest

toBuilder

public SearchProductsRequest.SearchProductsRequestBuilder toBuilder()

getLimit

public Integer getLimit()

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

getOffset

public Integer getOffset()

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

getOrderBy

public String getOrderBy()

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.

isArchived

public boolean isArchived()

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

isSortDescending

public boolean isSortDescending()

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object