SearchLicensesRequest.SearchLicensesRequestBuilder (Licensespring License Management 2.6.2 API)

java.lang.Object
- com.licensespring.management.dto.request.SearchLicensesRequest.SearchLicensesRequestBuilder

Enclosing class:: SearchLicensesRequest

public static class SearchLicensesRequest.SearchLicensesRequestBuilder
extends Object

The SearchLicensesRequest builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchLicensesRequest`	`build()`
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`company(Integer company)` The resulting set can be filtered by the company code.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`customerCompanyNameContains(String customerCompanyNameContains)` The resulting set can be filtered by the partial match of customers company name (case insensitive).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`customerEmail(String customerEmail)` The resulting set can be filtered by the email of the customer the licenses that need to be retrieved belong to
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`customerId(Integer customerId)` The resulting set can be filtered by the id of the customer the licenses that need to be retrieved belong to.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`customerNameContains(String customerNameContains)` The resulting set can be filtered by the partial customers name (case insensitive), either first or last name.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`customerReferenceContains(String customerReferenceContains)` The resulting set can be filtered by the partial match of customers reference (case insensitive).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`idIn(String idIn)` Comma separated list of ids.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`isAnyFloating(Boolean isAnyFloating)` If set to true, it will return only offline floating on-premises and offline floating cloud licenses.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseKey(String licenseKey)` The resulting set can be filtered by the license key of the license that needs to be retrieved (exact match).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseKeyContains(String licenseKeyContains)` The resulting set can be filtered by the partial license key (case insensitive).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseKeyIsNull(Boolean licenseKeyIsNull)` If set to true, the result will contain only user-based licenses.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseKeyStartsWith(String licenseKeyStartsWith)` The resulting set can be filtered by the partial match of the license key (starts with match).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseUserEmail(String licenseUserEmail)` The resulting set can be filtered by the exact match of the license users email.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseUserEmailContains(String licenseUserEmailContains)` The resulting set can be filtered by the partial match of the license users email (case insensitive).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`licenseUserEmailStartsWith(String licenseUserEmailStartsWith)` The resulting set can be filtered by the partial match of the license users email (starts with match).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`limit(Integer limit)` Number of results you want to be shown.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`noteContains(String noteContains)` The resulting set can be filtered by the partial match of the note attached to a license (case insensitive).
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`offset(Integer offset)` The initial index from which to return the results.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`orderBy(String orderBy)` The result of the queries is a list that can than be ordered in ascending order by some attribute.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`orderStoreId(String orderStoreId)` The resulting set can be filtered by the order store id that can be manually set in platform or through SDK.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`orderStoreIdContains(String orderStoreIdContains)` The resulting set can be filtered by the partial match of the order store id (case insensitive) that can be manually set in platform or through SDK.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`orderStoreIdStartsWith(String orderStoreIdStartsWith)` The resulting set can be filtered by the partial match of the Order store id (starts with match) that can be manually set in the platform platform or through SDK.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`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 SearchLicensesRequest.SearchLicensesRequestBuilder 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 SearchLicensesRequest.SearchLicensesRequestBuilder 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 SearchLicensesRequest.SearchLicensesRequestBuilder 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. See documentation on kwiki for all possible attribute that can order the list.
    
    Returns:
    
    this.
  - idIn
```
public SearchLicensesRequest.SearchLicensesRequestBuilder idIn(String idIn)
```
    Comma separated list of ids. Example = "1593781774572379,1597395059215709,1597395059216729".
    
    Returns:
    
    this.
  - company
```
public SearchLicensesRequest.SearchLicensesRequestBuilder company(Integer company)
```
    The resulting set can be filtered by the company code. If there are multiple companies under your management, this field can further specify from which company does the server filter through licenses.
    
    Returns:
    
    this.
  - customerId
```
public SearchLicensesRequest.SearchLicensesRequestBuilder customerId(Integer customerId)
```
    The resulting set can be filtered by the id of the customer the licenses that need to be retrieved belong to.
    
    Returns:
    
    this.
  - customerEmail
```
public SearchLicensesRequest.SearchLicensesRequestBuilder customerEmail(String customerEmail)
```
    The resulting set can be filtered by the email of the customer the licenses that need to be retrieved belong to
    
    Returns:
    
    this.
  - customerCompanyNameContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder customerCompanyNameContains(String customerCompanyNameContains)
```
    The resulting set can be filtered by the partial match of customers company name (case insensitive).
    
    Returns:
    
    this.
  - customerReferenceContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder customerReferenceContains(String customerReferenceContains)
```
    The resulting set can be filtered by the partial match of customers reference (case insensitive).
    
    Returns:
    
    this.
  - customerNameContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder customerNameContains(String customerNameContains)
```
    The resulting set can be filtered by the partial customers name (case insensitive), either first or last name.
    
    Returns:
    
    this.
  - licenseKeyStartsWith
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseKeyStartsWith(String licenseKeyStartsWith)
```
    The resulting set can be filtered by the partial match of the license key (starts with match). This field should be set only on key based licenses.
    
    Returns:
    
    this.
  - licenseKeyContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseKeyContains(String licenseKeyContains)
```
    The resulting set can be filtered by the partial license key (case insensitive).
    
    Returns:
    
    this.
  - licenseKey
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseKey(String licenseKey)
```
    The resulting set can be filtered by the license key of the license that needs to be retrieved (exact match).
    
    Returns:
    
    this.
  - licenseKeyIsNull
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseKeyIsNull(Boolean licenseKeyIsNull)
```
    If set to true, the result will contain only user-based licenses. If set to false, the result will contain only key-based licenses.
    
    Returns:
    
    this.
  - licenseUserEmailStartsWith
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseUserEmailStartsWith(String licenseUserEmailStartsWith)
```
    The resulting set can be filtered by the partial match of the license users email (starts with match).
    
    Returns:
    
    this.
  - licenseUserEmailContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseUserEmailContains(String licenseUserEmailContains)
```
    The resulting set can be filtered by the partial match of the license users email (case insensitive).
    
    Returns:
    
    this.
  - licenseUserEmail
```
public SearchLicensesRequest.SearchLicensesRequestBuilder licenseUserEmail(String licenseUserEmail)
```
    The resulting set can be filtered by the exact match of the license users email.
    
    Returns:
    
    this.
  - orderStoreIdStartsWith
```
public SearchLicensesRequest.SearchLicensesRequestBuilder orderStoreIdStartsWith(String orderStoreIdStartsWith)
```
    The resulting set can be filtered by the partial match of the Order store id (starts with match) that can be manually set in the platform platform or through SDK. Not to be confused with order id that the server generates.
    
    Returns:
    
    this.
  - orderStoreIdContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder orderStoreIdContains(String orderStoreIdContains)
```
    The resulting set can be filtered by the partial match of the order store id (case insensitive) that can be manually set in platform or through SDK. Not to be confused with order id that the server generates.
    
    Returns:
    
    this.
  - orderStoreId
```
public SearchLicensesRequest.SearchLicensesRequestBuilder orderStoreId(String orderStoreId)
```
    The resulting set can be filtered by the order store id that can be manually set in platform or through SDK. Not to be confused with order id that the server generates.
    
    Returns:
    
    this.
  - noteContains
```
public SearchLicensesRequest.SearchLicensesRequestBuilder noteContains(String noteContains)
```
    The resulting set can be filtered by the partial match of the note attached to a license (case insensitive).
    
    Returns:
    
    this.
  - isAnyFloating
```
public SearchLicensesRequest.SearchLicensesRequestBuilder isAnyFloating(Boolean isAnyFloating)
```
    If set to true, it will return only offline floating on-premises and offline floating cloud licenses. Else, it will return non-floating licenses.
    
    Returns:
    
    this.
  - sortDescending
```
public SearchLicensesRequest.SearchLicensesRequestBuilder 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 SearchLicensesRequest build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SearchLicensesRequest.SearchLicensesRequestBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

limit

offset

orderBy

idIn

company

customerId

customerEmail

customerCompanyNameContains

customerReferenceContains

customerNameContains

licenseKeyStartsWith

licenseKeyContains

licenseKey

licenseKeyIsNull

licenseUserEmailStartsWith

licenseUserEmailContains

licenseUserEmail

orderStoreIdStartsWith

orderStoreIdContains

orderStoreId

noteContains

isAnyFloating

sortDescending

build

toString