com.endeca.infront.cartridge.model

Class Refinement

java.lang.Object

com.endeca.infront.cartridge.model.Action

com.endeca.infront.cartridge.model.NavigationAction

com.endeca.infront.cartridge.model.Refinement

Direct Known Subclasses:

DimensionSearchValue

public class Refinement
extends NavigationAction

A view model that provides an action to perform dimension filtering with information about the resulting dataset when applied.

Constructor Summary

Constructors

Constructor and Description
Refinement()

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getCount()
Map<String,String>	getProperties()
boolean	isMultiSelect()
void	setCount(Integer count) Sets the number of records that will be returned if this refinement is applied.
void	setMultiSelect(boolean multiSelect) Sets the multi select flag.
void	setProperties(Map<String,String> properties) Sets the properties of this refinement

Methods inherited from class com.endeca.infront.cartridge.model.NavigationAction

getNavigationState, setNavigationState

Methods inherited from class com.endeca.infront.cartridge.model.Action

getContentPath, getLabel, getSiteRootPath, getSiteState, setContentPath, setLabel, setSiteRootPath, setSiteState

Methods inherited from class java.lang.Object

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

Constructor Detail

Refinement

public Refinement()

Method Detail

getProperties

public Map<String,String> getProperties()

Returns:

The additional information about this refinement a.k.a., dimension filter.

setProperties

public void setProperties(Map<String,String> properties)

Sets the properties of this refinement

Parameters:

properties - a map containing properties for this refinement

getCount

public Integer getCount()

Returns:

The number of results that will be returned if the refinement is applied.

setCount

public void setCount(Integer count)

Sets the number of records that will be returned if this refinement is applied.

Parameters:

count - the refinement count

isMultiSelect

public boolean isMultiSelect()

Returns:

True if this refinement is multi selectable.

setMultiSelect

public void setMultiSelect(boolean multiSelect)

Sets the multi select flag.

Parameters:

multiSelect - true if this refinement is multi selectable