com.endeca.infront.cartridge

Class RecordSpotlight

java.lang.Object

BasicContentItem

com.endeca.infront.cartridge.RecordSpotlight

public class RecordSpotlight
extends BasicContentItem

RecordSpotlightHandler output model.

See Also:

Record

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object

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

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.