Facets.DateTimeAttribute.Ranges

java.lang.Object
- io.sphere.internal.facets.FacetBase<DateTimeRangeFacetItem>
- - io.sphere.client.facets.Facets.DateTimeAttribute.Ranges

All Implemented Interfaces:: DateTimeRangeFacet, Facet<DateTimeRangeFacetItem>

Enclosing class:: Facets.DateTimeAttribute

@Immutable
public static final class Facets.DateTimeAttribute.Ranges
extends FacetBase<DateTimeRangeFacetItem>
implements DateTimeRangeFacet

Field Summary
- Fields inherited from class io.sphere.internal.facets.FacetBase
  attribute, isSingleSelect, queryParam

Constructor Summary

Constructors
Constructor and Description
`Facets.DateTimeAttribute.Ranges(java.lang.String attribute, java.lang.Iterable<com.google.common.collect.Range<org.joda.time.DateTime>> ranges)`
`Facets.DateTimeAttribute.Ranges(java.lang.String attribute, com.google.common.collect.Range<org.joda.time.DateTime> range, com.google.common.collect.Range<org.joda.time.DateTime>... ranges)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T> DateTimeRangeFacetResult`	`getResult(SearchResult<T> searchResult)` Returns the results for this facet.
`java.util.List<QueryParam>`	`getUrlParams(DateTimeRangeFacetItem item)` Returns application-level URL representation for given item of this facet.
`FacetExpressions.DateTimeAttribute.RangesMultiSelect`	`parse(java.util.Map<java.lang.String,java.lang.String[]> queryParams)` Creates a backend facet query based on application's URL query parameters.
`Facets.DateTimeAttribute.Ranges`	`setQueryParam(java.lang.String queryParam)` Sets a custom query parameter name that will represent this facet in application's query string.
`Facets.DateTimeAttribute.Ranges`	`setSingleSelect(boolean isSingleSelect)` If set to true, the user will only be able to select a single value at a time.

Methods inherited from class io.sphere.internal.facets.FacetBase
getAttributeName, getSelectLink, getUnselectLink, isSelected

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

Methods inherited from interface io.sphere.client.facets.Facet
getAttributeName, getSelectLink, getUnselectLink, isSelected

- Constructor Detail
  - Facets.DateTimeAttribute.Ranges
```
public Facets.DateTimeAttribute.Ranges(java.lang.String attribute,
                               com.google.common.collect.Range<org.joda.time.DateTime> range,
                               com.google.common.collect.Range<org.joda.time.DateTime>... ranges)
```
  - Facets.DateTimeAttribute.Ranges
```
public Facets.DateTimeAttribute.Ranges(java.lang.String attribute,
                               java.lang.Iterable<com.google.common.collect.Range<org.joda.time.DateTime>> ranges)
```
- Method Detail
  - parse
```
public FacetExpressions.DateTimeAttribute.RangesMultiSelect parse(java.util.Map<java.lang.String,java.lang.String[]> queryParams)
```
    Description copied from interface: Facet
    
    Creates a backend facet query based on application's URL query parameters.
    
    Specified by:
    
    parse in interface Facet<DateTimeRangeFacetItem>
  - getUrlParams
```
public java.util.List<QueryParam> getUrlParams(DateTimeRangeFacetItem item)
```
    Description copied from class: FacetBase
    
    Returns application-level URL representation for given item of this facet.
    
    Specified by:
    
    getUrlParams in interface Facet<DateTimeRangeFacetItem>
    
    Specified by:
    
    getUrlParams in class FacetBase<DateTimeRangeFacetItem>
  - setQueryParam
```
public Facets.DateTimeAttribute.Ranges setQueryParam(java.lang.String queryParam)
```
    Description copied from interface: Facet
    
    Sets a custom query parameter name that will represent this facet in application's query string.
    
    Specified by:
    
    setQueryParam in interface Facet<DateTimeRangeFacetItem>
  - setSingleSelect
```
public Facets.DateTimeAttribute.Ranges setSingleSelect(boolean isSingleSelect)
```
    Description copied from interface: Facet
    
    If set to true, the user will only be able to select a single value at a time. The default is false which means multiple values can be selected at the same time. The value of isSingleSelect influences the behavior of Facet.getSelectLink(T, java.util.Map<java.lang.String, java.lang.String[]>).
    
    Specified by:
    
    setSingleSelect in interface Facet<DateTimeRangeFacetItem>
  - getResult
```
public <T> DateTimeRangeFacetResult getResult(SearchResult<T> searchResult)
```
    Description copied from interface: DateTimeRangeFacet
    
    Returns the results for this facet.
    
    Specified by:
    
    getResult in interface DateTimeRangeFacet

Class Facets.DateTimeAttribute.Ranges

Field Summary

Fields inherited from class io.sphere.internal.facets.FacetBase

Constructor Summary

Method Summary

Methods inherited from class io.sphere.internal.facets.FacetBase

Methods inherited from class java.lang.Object

Methods inherited from interface io.sphere.client.facets.Facet

Constructor Detail

Facets.DateTimeAttribute.Ranges

Facets.DateTimeAttribute.Ranges

Method Detail

parse

getUrlParams

setQueryParam

setSingleSelect

getResult