GetStoreItemsRequest (formcycle: bom 8.2.0 API)

java.lang.Object
- de.xima.fc.proma.request.GetStoreItemsRequest

All Implemented Interfaces:

Serializable
```
@Immutable
public final class GetStoreItemsRequest
extends Object
implements Serializable
```
Model for a request to fetch all or some subset of store items from a particular store.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GetStoreItemsRequest.Builder
A builder for a GetStoreItemsRequest.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetStoreItemsRequest.Builder`	`builder(String storeKey)`	Creates a new builder for a request to fetch store items.
`String`	`getLicenseKey()`
`Set<String>`	`getLicenseTypes()`
`Locale`	`getLocale()`
`Set<String>`	`getNames()`
`String`	`getProductVersion()`
`String`	`getStoreKey()`
`Set<String>`	`getTags()`
`Set<String>`	`getTexts()`

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

- Method Detail
  - getLicenseTypes
```
public Set<String> getLicenseTypes()
```
    Returns:
    
    Optional set of license types to which to limit the fetched items.
  - getLocale
```
public Locale getLocale()
```
    Returns:
    
    Locale to use for localizing names, descriptions, and tags.
  - getNames
```
public Set<String> getNames()
```
    Returns:
    
    Optional set of names to which to limit the fetched items.
  - getProductVersion
```
public String getProductVersion()
```
    Returns:
    
    Optional product version to which to limit the fetched items.
  - getStoreKey
```
public String getStoreKey()
```
    Returns:
    
    Key of the store from which to fetch items.
  - getTags
```
public Set<String> getTags()
```
    Returns:
    
    Optional set of tags to which to limit the fetched items.
  - getTexts
```
public Set<String> getTexts()
```
    Returns:
    
    Optional set of descriptions to which to limit the fetched items.
  - builder
```
public static GetStoreItemsRequest.Builder builder(String storeKey)
```
    Creates a new builder for a request to fetch store items.
    
    Parameters:
    
    storeKey - Store key from which to fetch items.
    
    Returns:
    
    A new builder for adding filters to the request.
  - getLicenseKey
```
public String getLicenseKey()
```
    Returns:
    
    licenseKey The license key of the current license. This could be either the system license or a client license.