com.groupbyinc.api.request

Class SelectedRefinement<T extends SelectedRefinement<T>>

java.lang.Object

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

Direct Known Subclasses:

SelectedRefinementRange, SelectedRefinementValue

public abstract class SelectedRefinement<T extends SelectedRefinement<T>>
extends java.lang.Object

Abstract Refinement class holding common methods for RefinementRange and RefinementValue.

Author:

will

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectedRefinement.Type

Constructor Summary

Constructors

Constructor and Description
SelectedRefinement()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getExclude()
java.lang.String	getId()
java.lang.String	getNavigationName()
abstract SelectedRefinement.Type	getType() Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue
boolean	isRange()
T	setExclude(java.lang.Boolean exclude)
T	setId(java.lang.String id)
T	setNavigationName(java.lang.String navigationName)
abstract java.lang.String	toTildeString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectedRefinement

public SelectedRefinement()

Method Detail

getId

public java.lang.String getId()

Returns:

The ID is a MD5 of the name and value of the refinement.

setId

public T setId(java.lang.String id)

Parameters:

id - Set the ID

Returns:

getNavigationName

public java.lang.String getNavigationName()

Returns:

The navigation name

setNavigationName

public T setNavigationName(java.lang.String navigationName)

Parameters:

navigationName - Set the navigation name

Returns:

isRange

public boolean isRange()

Returns:

True if this refinement a range.

getType

public abstract SelectedRefinement.Type getType()

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

Returns:

The type of this refinement

toTildeString

public abstract java.lang.String toTildeString()

Returns:

getExclude

public java.lang.Boolean getExclude()

Returns:

The boolean to determine if the refinement should be excluded from the result

setExclude

public T setExclude(java.lang.Boolean exclude)

Parameters:

exclude - Set the exclude

Returns: