com.endeca.infront.cartridge

Class RecordSpotlightSelection

java.lang.Object

com.endeca.infront.cartridge.RecordSpotlightSelection

public class RecordSpotlightSelection
extends Object

Represents a record selection from content XML. Corresponding to the parsing result of Record Element or NavigationState Element from 2010 schema.

Constructor Summary

Constructors

Constructor and Description
RecordSpotlightSelection()

Method Summary

Modifier and Type	Method and Description
FilterState	getFilterState() Returns the filter state.
int	getRecordLimit() Gets the record limit.
SortOption	getSortOption() Returns the SortOption.
boolean	isAugment() Indicates whether current record selection should be augmented by the current navigation state.
boolean	isEmpty() Return if this selection is empty.
void	setAugment(boolean augment) Sets whether current record selection should be augmented by the current navigation state.
void	setFilterState(FilterState filterState) Sets the filter state.
void	setRecordLimit(int recordLimit) Sets the record limit.
void	setSortOption(SortOption sortOption) Sets the SortOption.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordSpotlightSelection

public RecordSpotlightSelection()

Method Detail

getFilterState

public FilterState getFilterState()

Returns the filter state.

Returns:

the filterState

setFilterState

public void setFilterState(FilterState filterState)

Sets the filter state.

Parameters:

filterState - the filterState to set

getSortOption

public SortOption getSortOption()

Returns the SortOption.

Returns:

the sortOption

setSortOption

public void setSortOption(SortOption sortOption)

Sets the SortOption.

Parameters:

sortOption - the sortOption to set

isAugment

public boolean isAugment()

Indicates whether current record selection should be augmented by the current navigation state.

setAugment

public void setAugment(boolean augment)

Sets whether current record selection should be augmented by the current navigation state.

getRecordLimit

public int getRecordLimit()

Gets the record limit.

setRecordLimit

public void setRecordLimit(int recordLimit)

Sets the record limit.

isEmpty

public boolean isEmpty()

Return if this selection is empty.

Returns:

true if the sortOption is null and the filterState is null or empty