com.endeca.mobile.tags.model
Class NavState

java.lang.Object
  com.endeca.mobile.tags.model.NavState

public class NavState
extends java.lang.Object

Constructor Summary

NavState()

NavState(com.endeca.navigation.Dimension descriptorDimension)

NavState(com.endeca.navigation.ENEQuery query, com.endeca.navigation.Navigation nav)
Used for navigation queries

Method Summary

java.util.List	getDescriptorDimensions() A list of Dimension objects
com.endeca.navigation.RangeFilterList	getRangeFilters()
java.lang.String	getRecordFilter()
java.util.List	getRecordSpecs() A list of RecordSpec objects
com.endeca.navigation.ERecSearchList	getSearches()
com.endeca.navigation.ERecSortKeyList	getSorts()
boolean	isAugmentNavState() Defaults to false
boolean	isSkipContent()
void	setAugmentNavState(boolean augmentNavState)
void	setDescriptorDimensions(java.util.List descriptorDimensions) A list of Dimension objects
void	setRangeFilters(com.endeca.navigation.RangeFilterList rangeFilters)
void	setRecordFilter(java.lang.String recordFilter)
void	setRecordSpecs(java.util.List recordSpecs) A list of RecordSpec objects
void	setSearches(com.endeca.navigation.ERecSearchList searches)
void	setSkipContent(boolean skipContent)
void	setSorts(com.endeca.navigation.ERecSortKeyList sorts)

Methods inherited from class java.lang.Object

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

Constructor Detail

NavState

public NavState()

NavState

public NavState(com.endeca.navigation.Dimension descriptorDimension)

NavState

public NavState(com.endeca.navigation.ENEQuery query,
                com.endeca.navigation.Navigation nav)

Used for navigation queries

Parameters:

query -

nav - - the Navigation from the ENEQueryResults of the query

Method Detail

getSearches

public com.endeca.navigation.ERecSearchList getSearches()

Returns:

the searches, or an empty ERecSearchList.

setSearches

public void setSearches(com.endeca.navigation.ERecSearchList searches)

Parameters:

searches - the searches to set. If searches is null, creates a new empty ERecSearchList

getRangeFilters

public com.endeca.navigation.RangeFilterList getRangeFilters()

Returns:

the rangeFilters, or an empty RangeFilterList.

setRangeFilters

public void setRangeFilters(com.endeca.navigation.RangeFilterList rangeFilters)

Parameters:

rangeFilters - the rangeFilters to set. If rangeFilters is null, creates a new empty RangeFilterList.

getDescriptorDimensions

public java.util.List getDescriptorDimensions()

A list of Dimension objects

Returns:

the descriptorDimensions, or an empty ArrayList.

setDescriptorDimensions

public void setDescriptorDimensions(java.util.List descriptorDimensions)

A list of Dimension objects

Parameters:

descriptorDimensions - the descriptorDimensions to set. If descriptorDimensions is null, creates a new empty ArrayList.

getRecordSpecs

public java.util.List getRecordSpecs()

A list of RecordSpec objects

Returns:

the recordSpecs, or an empty List.

setRecordSpecs

public void setRecordSpecs(java.util.List recordSpecs)

A list of RecordSpec objects

Parameters:

recordSpecs - the list of RecordSpec records. If recordSpecs is null, creates a new empty List.

getSorts

public com.endeca.navigation.ERecSortKeyList getSorts()

Returns:

the sorts, or an empty ERecSortKeyList

setSorts

public void setSorts(com.endeca.navigation.ERecSortKeyList sorts)

Parameters:

sorts - the sorts to set. If sorts is null, creates a new empty ERecSortKeyList.

getRecordFilter

public java.lang.String getRecordFilter()

Returns:

the record filter, or null

setRecordFilter

public void setRecordFilter(java.lang.String recordFilter)

Parameters:

recordFilter - the recordFilter to set.

isSkipContent

public boolean isSkipContent()

Returns:

the skipContent

setSkipContent

public void setSkipContent(boolean skipContent)

Parameters:

skipContent - the skipContent to set

isAugmentNavState

public boolean isAugmentNavState()

Defaults to false

Returns:

whether to add the nav state in this NavStateItem to the current navigation state.

setAugmentNavState

public void setAugmentNavState(boolean augmentNavState)