com.endeca.infront.cartridge

Class MediaBannerConfig

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.endeca.infront.assembler.BasicContentItem

com.endeca.infront.cartridge.MediaBannerConfig

All Implemented Interfaces:

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

public class MediaBannerConfig
extends BasicContentItem

MediaBannerConfig configuration model.

See Also:

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

Constructors

Constructor and Description
MediaBannerConfig() Creates an empty MediaBannerConfig.
MediaBannerConfig(ContentItem pContentItem) Creates a copy of the specified ContentItem, and returns it as an instance of MediaBannerConfig.
MediaBannerConfig(String pType) Creates an empty MediaBannerConfig with the specified type.

Method Summary

Methods

Modifier and Type	Method and Description
LinkBuilder	getLink() Returns the LinkBuilder object used to construct the link which fires when the media is clicked (if desired).
MediaObject	getMedia() Returns the media object to be displayed.
void	setLink(LinkBuilder link) Sets the LinkBuilder object used to construct the link which fires when the media is clicked.
void	setMedia(MediaObject media) Sets the media object to be displayed.

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

MediaBannerConfig

public MediaBannerConfig()

Creates an empty MediaBannerConfig.

MediaBannerConfig

public MediaBannerConfig(String pType)

Creates an empty MediaBannerConfig with the specified type.

Parameters:

pType - a value that will be used as the type

See Also:

BasicContentItem.getType()

MediaBannerConfig

public MediaBannerConfig(ContentItem pContentItem)

Creates a copy of the specified ContentItem, and returns it as an instance of MediaBannerConfig.

Method Detail

getLink

public LinkBuilder getLink()

Returns the LinkBuilder object used to construct the link which fires when the media is clicked (if desired). May be null.

setLink

public void setLink(LinkBuilder link)

Sets the LinkBuilder object used to construct the link which fires when the media is clicked. May be null.

getMedia

public MediaObject getMedia()

Returns the media object to be displayed. If this value is null, a CartridgeHandlerException will be thrown from MediaBannerHandler.preprocess(MediaBannerConfig).

setMedia

public void setMedia(MediaObject media)

Sets the media object to be displayed. Should not be null, else a CartridgeHandlerException will be thrown from MediaBannerHandler.preprocess(MediaBannerConfig).