SearchOrdersRequest.SearchOrdersRequestBuilder (Licensespring License Management 2.6.2 API)

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

Enclosing class:: SearchOrdersRequest

public static class SearchOrdersRequest.SearchOrdersRequestBuilder
extends Object

The SearchOrdersRequest builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchOrdersRequest`	`build()`
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`clientOrderId(String clientOrderId)` The resulting set can be filtered by a client order id that can be manually set in platform or through the SDK.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`clientOrderIdContains(String clientOrderIdContains)` The resulting set can be filtered by a partial order store id that can be manually set in platform or through SDK.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`clientOrderIdStartsWith(String clientOrderIdStartsWith)` The resulting set can be filtered by a custom order ID (partial match).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`company(Integer company)` The resulting set can be filtered by an id of the company that issued the license.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerCompanyName(String customerCompanyName)` The resulting set can be filtered by customer's company name (exact match, but case insensitive).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerCompanyNameContains(String customerCompanyNameContains)` The resulting set can be filtered by customer's company name (partial match, case insensitive).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerEmail(String customerEmail)` The resulting set can be filtered by customer email (exact match).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerEmailContains(String customerEmailContains)` The resulting set can be filtered by customer email (partial match, case insensitive).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerEmailStartsWith(String customerEmailStartsWith)` The resulting set can be filtered by customer email (startsWith match).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerId(Integer customerId)` The resulting set can be filtered by customerId (exact match).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerLabel(String customerLabel)` 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.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerNameContains(String customerNameContains)` The resulting set can be filtered by a partial match of customers name, either first or last name.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`customerReferenceContains(String customerReferenceContains)` The resulting set can be filtered by a custom reference (partial match, case insensitive).
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`limit(Integer limit)` Number of results that will be retrieved in one request to the server.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`offset(Integer offset)` The initial index from which to return the results.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`orderBy(String orderBy)` The resulting set can be ordered by a Order field, after the filters are applied.
`SearchOrdersRequest.SearchOrdersRequestBuilder`	`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 SearchOrdersRequest.SearchOrdersRequestBuilder limit(Integer limit)
```
    Number of results that will be retrieved in one request to the server. Default value is 20.
    
    Returns:
    
    this.
  - offset
```
public SearchOrdersRequest.SearchOrdersRequestBuilder offset(Integer offset)
```
    The initial index from which to return the results. Server response will skip offset number of records.
    
    Returns:
    
    this.
  - orderBy
```
public SearchOrdersRequest.SearchOrdersRequestBuilder orderBy(String orderBy)
```
    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.
    
    Returns:
    
    this.
  - company
```
public SearchOrdersRequest.SearchOrdersRequestBuilder company(Integer company)
```
    The resulting set can be filtered by an id of the company that issued the license.
    
    Returns:
    
    this.
  - customerId
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerId(Integer customerId)
```
    The resulting set can be filtered by customerId (exact match).
    
    Returns:
    
    this.
  - customerEmail
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerEmail(String customerEmail)
```
    The resulting set can be filtered by customer email (exact match).
    
    Returns:
    
    this.
  - customerEmailStartsWith
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerEmailStartsWith(String customerEmailStartsWith)
```
    The resulting set can be filtered by customer email (startsWith match).
    
    Returns:
    
    this.
  - customerEmailContains
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerEmailContains(String customerEmailContains)
```
    The resulting set can be filtered by customer email (partial match, case insensitive).
    
    Returns:
    
    this.
  - customerCompanyNameContains
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerCompanyNameContains(String customerCompanyNameContains)
```
    The resulting set can be filtered by customer's company name (partial match, case insensitive).
    
    Returns:
    
    this.
  - customerCompanyName
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerCompanyName(String customerCompanyName)
```
    The resulting set can be filtered by customer's company name (exact match, but case insensitive).
    
    Returns:
    
    this.
  - customerReferenceContains
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerReferenceContains(String customerReferenceContains)
```
    The resulting set can be filtered by a custom reference (partial match, case insensitive).
    
    Returns:
    
    this.
  - customerNameContains
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerNameContains(String customerNameContains)
```
    The resulting set can be filtered by a partial match of customers name, either first or last name. Case insensitive.
    
    Returns:
    
    this.
  - clientOrderId
```
public SearchOrdersRequest.SearchOrdersRequestBuilder clientOrderId(String clientOrderId)
```
    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.
    
    Returns:
    
    this.
  - clientOrderIdStartsWith
```
public SearchOrdersRequest.SearchOrdersRequestBuilder clientOrderIdStartsWith(String clientOrderIdStartsWith)
```
    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()
    
    Returns:
    
    this.
  - clientOrderIdContains
```
public SearchOrdersRequest.SearchOrdersRequestBuilder clientOrderIdContains(String clientOrderIdContains)
```
    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.
    
    Returns:
    
    this.
  - customerLabel
```
public SearchOrdersRequest.SearchOrdersRequestBuilder customerLabel(String customerLabel)
```
    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";
    
    Returns:
    
    this.
  - sortDescending
```
public SearchOrdersRequest.SearchOrdersRequestBuilder 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 SearchOrdersRequest build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SearchOrdersRequest.SearchOrdersRequestBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

limit

offset

orderBy

company

customerId

customerEmail

customerEmailStartsWith

customerEmailContains

customerCompanyNameContains

customerCompanyName

customerReferenceContains

customerNameContains

clientOrderId

clientOrderIdStartsWith

clientOrderIdContains

customerLabel

sortDescending

build

toString