Package de.xima.fc.proma.request
Class GetStoreItemsRequest.Builder
- java.lang.Object
 - 
- de.xima.fc.proma.request.GetStoreItemsRequest.Builder
 
 
- 
- Enclosing class:
 - GetStoreItemsRequest
 
public static final class GetStoreItemsRequest.Builder extends Object
A builder for aGetStoreItemsRequest.- Since:
 - 8.0.0
 - Author:
 - XIMA MEDIA GmbH
 
 
- 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetStoreItemsRequestbuild()Creates a new request with the current data.GetStoreItemsRequest.BuilderlicenseKey(String licenseKey)Limits the returned items to those that are compatible with the current license.GetStoreItemsRequest.BuilderlicenseTypes(Iterable<String> licenseTypes)Limits the returned items to those with the given license types.GetStoreItemsRequest.Builderlocale(Locale locale)Sets the locale for localizing names and descriptions etc.GetStoreItemsRequest.Buildernames(Iterable<String> names)Limits the returned items to those that have a matching name.GetStoreItemsRequest.BuilderproductVersion(String productVersion)Limits the returned items to those that are compatible with the given product version.GetStoreItemsRequest.Buildertags(Iterable<String> tags)Limits the returned items to those that have a matching tag.GetStoreItemsRequest.Buildertexts(Iterable<String> texts)Limits the returned items to those that have a matching description. 
 - 
 
- 
- 
Method Detail
- 
build
public GetStoreItemsRequest build()
Creates a new request with the current data. Subsequent modification to this builder will not affect the built request.- Returns:
 - A new store item request with the current data.
 
 
- 
licenseTypes
public GetStoreItemsRequest.Builder licenseTypes(Iterable<String> licenseTypes)
Limits the returned items to those with the given license types.- Parameters:
 licenseTypes- License types to which to limit the fetched items.- Returns:
 - This builder instance for chaining method calls.
 
 
- 
locale
public GetStoreItemsRequest.Builder locale(Locale locale)
Sets the locale for localizing names and descriptions etc. Defaults to English.- Parameters:
 locale- Locale to use.- Returns:
 - This builder instance for chaining method calls.
 
 
- 
names
public GetStoreItemsRequest.Builder names(Iterable<String> names)
Limits the returned items to those that have a matching name.- Parameters:
 names- Names to which to limit the fetched items.- Returns:
 - This builder instance for chaining method calls.
 
 
- 
productVersion
public GetStoreItemsRequest.Builder productVersion(String productVersion)
Limits the returned items to those that are compatible with the given product version. Defaults to no restriction.- Parameters:
 productVersion- Product version to which to limit the fetched items.- Returns:
 - This builder instance for chaining method calls.
 
 
- 
licenseKey
public GetStoreItemsRequest.Builder licenseKey(String licenseKey)
Limits the returned items to those that are compatible with the current license.- Parameters:
 licenseKey- The license key of the current license. This could be either the system license or a client license.- Returns:
 - This builder instance for chaining method calls.
 
 
- 
tags
public GetStoreItemsRequest.Builder tags(Iterable<String> tags)
Limits the returned items to those that have a matching tag.- Parameters:
 tags- Tags to which to limit the fetched items.- Returns:
 - This builder instance for chaining method calls.
 
 
- 
texts
public GetStoreItemsRequest.Builder texts(Iterable<String> texts)
Limits the returned items to those that have a matching description.- Parameters:
 texts- Descriptions to which to limit the fetched items.- Returns:
 - This builder instance for chaining method calls.
 
 
 - 
 
 -