SearchLicensesRequest (Licensespring License Management 2.6.2 API)

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

```
public final class SearchLicensesRequest
extends Object
```
Data transfer object that is used for searching through all licenses. All fields represent a query that can be used to filter through licenses. Use the builder to populate the request.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchLicensesRequest.SearchLicensesRequestBuilder
The SearchLicensesRequest builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchLicensesRequest.SearchLicensesRequestBuilder` The SearchLicensesRequest builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchLicensesRequest.SearchLicensesRequestBuilder`	`builder()` Use this builder to construct the search request.
`boolean`	`equals(Object o)`
`Integer`	`getCompany()` The resulting set can be filtered by the company code.
`String`	`getCustomerCompanyNameContains()` The resulting set can be filtered by the partial match of customers company name (case insensitive).
`String`	`getCustomerEmail()` The resulting set can be filtered by the email of the customer the licenses that need to be retrieved belong to
`Integer`	`getCustomerId()` The resulting set can be filtered by the id of the customer the licenses that need to be retrieved belong to.
`String`	`getCustomerNameContains()` The resulting set can be filtered by the partial customers name (case insensitive), either first or last name.
`String`	`getCustomerReferenceContains()` The resulting set can be filtered by the partial match of customers reference (case insensitive).
`String`	`getIdIn()` Comma separated list of ids.
`Boolean`	`getIsAnyFloating()` If set to true, it will return only offline floating on-premises and offline floating cloud licenses.
`String`	`getLicenseKey()` The resulting set can be filtered by the license key of the license that needs to be retrieved (exact match).
`String`	`getLicenseKeyContains()` The resulting set can be filtered by the partial license key (case insensitive).
`Boolean`	`getLicenseKeyIsNull()` If set to true, the result will contain only user-based licenses.
`String`	`getLicenseKeyStartsWith()` The resulting set can be filtered by the partial match of the license key (starts with match).
`String`	`getLicenseUserEmail()` The resulting set can be filtered by the exact match of the license users email.
`String`	`getLicenseUserEmailContains()` The resulting set can be filtered by the partial match of the license users email (case insensitive).
`String`	`getLicenseUserEmailStartsWith()` The resulting set can be filtered by the partial match of the license users email (starts with match).
`Integer`	`getLimit()` Number of results you want to be shown.
`String`	`getNoteContains()` The resulting set can be filtered by the partial match of the note attached to a license (case insensitive).
`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.
`String`	`getOrderStoreId()` The resulting set can be filtered by the order store id that can be manually set in platform or through SDK.
`String`	`getOrderStoreIdContains()` 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.
`String`	`getOrderStoreIdStartsWith()` 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.
`int`	`hashCode()`
`boolean`	`isSortDescending()` Indicates if the results of the queries should be ordered in descending order.
`SearchLicensesRequest.SearchLicensesRequestBuilder`	`toBuilder()`
`String`	`toString()`

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

- Method Detail
  - builder
```
public static SearchLicensesRequest.SearchLicensesRequestBuilder builder()
```
    Use this builder to construct the search request.
    
    Returns:
    
    the builder for the SearchDevicesRequest
  - toBuilder
```
public SearchLicensesRequest.SearchLicensesRequestBuilder 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. See documentation on kwiki for all possible attribute that can order the list.
  - getIdIn
```
public String getIdIn()
```
    Comma separated list of ids. Example = "1593781774572379,1597395059215709,1597395059216729".
  - getCompany
```
public Integer getCompany()
```
    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.
  - getCustomerId
```
public Integer getCustomerId()
```
    The resulting set can be filtered by the id of the customer the licenses that need to be retrieved belong to.
  - getCustomerEmail
```
public String getCustomerEmail()
```
    The resulting set can be filtered by the email of the customer the licenses that need to be retrieved belong to
  - getCustomerCompanyNameContains
```
public String getCustomerCompanyNameContains()
```
    The resulting set can be filtered by the partial match of customers company name (case insensitive).
  - getCustomerReferenceContains
```
public String getCustomerReferenceContains()
```
    The resulting set can be filtered by the partial match of customers reference (case insensitive).
  - getCustomerNameContains
```
public String getCustomerNameContains()
```
    The resulting set can be filtered by the partial customers name (case insensitive), either first or last name.
  - getLicenseKeyStartsWith
```
public String getLicenseKeyStartsWith()
```
    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.
  - getLicenseKeyContains
```
public String getLicenseKeyContains()
```
    The resulting set can be filtered by the partial license key (case insensitive).
  - getLicenseKey
```
public String getLicenseKey()
```
    The resulting set can be filtered by the license key of the license that needs to be retrieved (exact match).
  - getLicenseKeyIsNull
```
public Boolean getLicenseKeyIsNull()
```
    If set to true, the result will contain only user-based licenses. If set to false, the result will contain only key-based licenses.
  - getLicenseUserEmailStartsWith
```
public String getLicenseUserEmailStartsWith()
```
    The resulting set can be filtered by the partial match of the license users email (starts with match).
  - getLicenseUserEmailContains
```
public String getLicenseUserEmailContains()
```
    The resulting set can be filtered by the partial match of the license users email (case insensitive).
  - getLicenseUserEmail
```
public String getLicenseUserEmail()
```
    The resulting set can be filtered by the exact match of the license users email.
  - getOrderStoreIdStartsWith
```
public String getOrderStoreIdStartsWith()
```
    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.
  - getOrderStoreIdContains
```
public String getOrderStoreIdContains()
```
    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.
  - getOrderStoreId
```
public String getOrderStoreId()
```
    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.
  - getNoteContains
```
public String getNoteContains()
```
    The resulting set can be filtered by the partial match of the note attached to a license (case insensitive).
  - getIsAnyFloating
```
public Boolean getIsAnyFloating()
```
    If set to true, it will return only offline floating on-premises and offline floating cloud licenses. Else, it will return non-floating licenses.
  - 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 SearchLicensesRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

toBuilder

getLimit

getOffset

getOrderBy

getIdIn

getCompany

getCustomerId

getCustomerEmail

getCustomerCompanyNameContains

getCustomerReferenceContains

getCustomerNameContains

getLicenseKeyStartsWith

getLicenseKeyContains

getLicenseKey

getLicenseKeyIsNull

getLicenseUserEmailStartsWith

getLicenseUserEmailContains

getLicenseUserEmail

getOrderStoreIdStartsWith

getOrderStoreIdContains

getOrderStoreId

getNoteContains

getIsAnyFloating

isSortDescending

equals

hashCode

toString