com.endeca.infront.cartridge
Class RecordSpotlight

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          com.endeca.infront.assembler.BasicContentItem
              com.endeca.infront.cartridge.RecordSpotlight

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class RecordSpotlight
extends BasicContentItem

RecordSpotlightHandler output model.

See Also:

Record, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

RecordSpotlight(RecordSpotlightConfig pConfig)
Creates the RecordSpotlight output model, using the type and data present in the input RecordSpotlightConfig.

Method Summary

List<Record>	getRecords() The list of records.
NavigationAction	getSeeAllLink() Returns a NavigationAction to a page with the nav state specified by the record selection.
void	setRecords(List<Record> records) Sets the list of records.
void	setSeeAllLink(NavigationAction seeAllLink) Sets the See All NavigationAction.

Methods inherited from class com.endeca.infront.assembler.BasicContentItem

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

RecordSpotlight

public RecordSpotlight(RecordSpotlightConfig pConfig)

Creates the RecordSpotlight output model, using the type and data present in the input RecordSpotlightConfig.

Method Detail

getRecords

public List<Record> getRecords()

The list of records.

setRecords

public void setRecords(List<Record> records)

Sets the list of records.

getSeeAllLink

public NavigationAction getSeeAllLink()

Returns a NavigationAction to a page with the nav state specified by the record selection. If the record selection is specified by a list of Record specs, this method returns null. This method will also return null if the see all link is not configured (RecordSpotlightConfig.getSeeAllLinkText() is null).

Returns:

an action to a page with the navigation state specified by the record selection if it exists, null otherwise.

setSeeAllLink

public void setSeeAllLink(NavigationAction seeAllLink)

Sets the See All NavigationAction.