com.groupbyinc.api.request.refinement

Class SelectedRefinementValue

java.lang.Object

com.groupbyinc.api.request.SelectedRefinement<SelectedRefinementValue>

com.groupbyinc.api.request.refinement.SelectedRefinementValue

public class SelectedRefinementValue
extends SelectedRefinement<SelectedRefinementValue>

A RefinementValue extends Refinement and represents a navigation refinement that holds a value. Typically, brand is a value refinement. - `id`: an MD5 hash of the content of this value. - `value`: The value of the refinement. - `count`: the number of records that will be filtered down to by this navigation value. - `displayName`: A never blank combination of the value / low and high properties. - `navigationName`: - the name of the parent navigation. - `isRange`: - whether this is a range refinement or a value refinement - `type`: - the type of refinement, Value or Range

Author:

will

Nested Class Summary

Nested classes/interfaces inherited from class com.groupbyinc.api.request.SelectedRefinement

SelectedRefinement.Type

Constructor Summary

Constructors

Constructor and Description
SelectedRefinementValue()

Method Summary

Modifier and Type	Method and Description
SelectedRefinement.Type	getType() Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue
java.lang.String	getValue()
SelectedRefinementValue	setValue(java.lang.String value)
java.lang.String	toTildeString()

Methods inherited from class com.groupbyinc.api.request.SelectedRefinement

getExclude, getId, getNavigationName, isRange, setExclude, setId, setNavigationName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SelectedRefinementValue

public SelectedRefinementValue()

Method Detail

getType

public SelectedRefinement.Type getType()

Description copied from class: SelectedRefinement

Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue

Specified by:

getType in class SelectedRefinement<SelectedRefinementValue>

Returns:

Type.Value

toTildeString

public java.lang.String toTildeString()

Specified by:

toTildeString in class SelectedRefinement<SelectedRefinementValue>

Returns:

getValue

public java.lang.String getValue()

Returns:

the value of this refinement

setValue

public SelectedRefinementValue setValue(java.lang.String value)

Parameters:

value - Set the value

Returns: