SearchOrdersRequest (Licensespring License Management 2.6.2 API)

java.lang.Object
- com.licensespring.management.dto.request.SearchOrdersRequest

```
public final class SearchOrdersRequest
extends Object
```
Data transfer object that is used for searching through all orders. All fields represent a query that can be used to filter through orders.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchOrdersRequest.SearchOrdersRequestBuilder
The SearchOrdersRequest builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchOrdersRequest.SearchOrdersRequestBuilder` The SearchOrdersRequest builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchOrdersRequest.SearchOrdersRequestBuilder`	`builder()` Use this builder to construct the search request.
`boolean`	`equals(Object o)`
`String`	`getClientOrderId()` The resulting set can be filtered by a client order id that can be manually set in platform or through the SDK.
`String`	`getClientOrderIdContains()` The resulting set can be filtered by a partial order store id that can be manually set in platform or through SDK.
`String`	`getClientOrderIdStartsWith()` The resulting set can be filtered by a custom order ID (partial match).
`Integer`	`getCompany()` The resulting set can be filtered by an id of the company that issued the license.
`String`	`getCustomerCompanyName()` The resulting set can be filtered by customer's company name (exact match, but case insensitive).
`String`	`getCustomerCompanyNameContains()` The resulting set can be filtered by customer's company name (partial match, case insensitive).
`String`	`getCustomerEmail()` The resulting set can be filtered by customer email (exact match).
`String`	`getCustomerEmailContains()` The resulting set can be filtered by customer email (partial match, case insensitive).
`String`	`getCustomerEmailStartsWith()` The resulting set can be filtered by customer email (startsWith match).
`Integer`	`getCustomerId()` The resulting set can be filtered by customerId (exact match).
`String`	`getCustomerLabel()` The resulting set can be filtered by customers label, the set will contain all orders whose customer has one or more labels from this String.
`String`	`getCustomerNameContains()` The resulting set can be filtered by a partial match of customers name, either first or last name.
`String`	`getCustomerReferenceContains()` The resulting set can be filtered by a custom reference (partial match, case insensitive).
`Integer`	`getLimit()` Number of results that will be retrieved in one request to the server.
`Integer`	`getOffset()` The initial index from which to return the results.
`String`	`getOrderBy()` The resulting set can be ordered by a Order field, after the filters are applied.
`int`	`hashCode()`
`boolean`	`isSortDescending()` Indicates if the results of the queries should be ordered in descending order.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static SearchOrdersRequest.SearchOrdersRequestBuilder builder()
```
    Use this builder to construct the search request.
    
    Returns:
    
    the builder for the SearchOrdersRequest
  - toBuilder
```
public SearchOrdersRequest.SearchOrdersRequestBuilder toBuilder()
```
  - getLimit
```
public Integer getLimit()
```
    Number of results that will be retrieved in one request to the server. Default value is 20.
  - getOffset
```
public Integer getOffset()
```
    The initial index from which to return the results. Server response will skip offset number of records.
  - getOrderBy
```
public String getOrderBy()
```
    The resulting set can be ordered by a Order field, after the filters are applied. See docs on kwiki for full list of possible sorts.
  - getCompany
```
public Integer getCompany()
```
    The resulting set can be filtered by an id of the company that issued the license.
  - getCustomerId
```
public Integer getCustomerId()
```
    The resulting set can be filtered by customerId (exact match).
  - getCustomerEmail
```
public String getCustomerEmail()
```
    The resulting set can be filtered by customer email (exact match).
  - getCustomerEmailStartsWith
```
public String getCustomerEmailStartsWith()
```
    The resulting set can be filtered by customer email (startsWith match).
  - getCustomerEmailContains
```
public String getCustomerEmailContains()
```
    The resulting set can be filtered by customer email (partial match, case insensitive).
  - getCustomerCompanyNameContains
```
public String getCustomerCompanyNameContains()
```
    The resulting set can be filtered by customer's company name (partial match, case insensitive).
  - getCustomerCompanyName
```
public String getCustomerCompanyName()
```
    The resulting set can be filtered by customer's company name (exact match, but case insensitive).
  - getCustomerReferenceContains
```
public String getCustomerReferenceContains()
```
    The resulting set can be filtered by a custom reference (partial match, case insensitive).
  - getCustomerNameContains
```
public String getCustomerNameContains()
```
    The resulting set can be filtered by a partial match of customers name, either first or last name. Case insensitive.
  - getClientOrderId
```
public String getClientOrderId()
```
    The resulting set can be filtered by a client order id that can be manually set in platform or through the SDK. Not to be confused with order id that the server generates.
  - getClientOrderIdStartsWith
```
public String getClientOrderIdStartsWith()
```
    The resulting set can be filtered by a custom order ID (partial match). Not to be confused with order id that the server generates. WebhookOrder.getDownloadId()
  - getClientOrderIdContains
```
public String getClientOrderIdContains()
```
    The resulting set can be filtered by a partial order store id that can be manually set in platform or through SDK. Not to be confused with order id that the server generates. Case insensitive.
  - getCustomerLabel
```
public String getCustomerLabel()
```
    The resulting set can be filtered by customers label, the set will contain all orders whose customer has one or more labels from this String. The string needs to be filled with label id(s), separated by a comma. E.g. customerLabel = "2,4";
  - 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

Class SearchOrdersRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

toBuilder

getLimit

getOffset

getOrderBy

getCompany

getCustomerId

getCustomerEmail

getCustomerEmailStartsWith

getCustomerEmailContains

getCustomerCompanyNameContains

getCustomerCompanyName

getCustomerReferenceContains

getCustomerNameContains

getClientOrderId

getClientOrderIdStartsWith

getClientOrderIdContains

getCustomerLabel

isSortDescending

equals

hashCode

toString