|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.infront.cartridge.NavigationCartridgeHandler<MediaBannerConfig,MediaBanner> com.endeca.infront.cartridge.MediaBannerHandler
public class MediaBannerHandler
Cartridge handler that creates MediaObject
model objects.
Constructor Summary | |
---|---|
MediaBannerHandler()
|
Method Summary | |
---|---|
ContentSource |
getContentSource()
Returns the content source that will be used to create Action objects. |
List<MediaSourceConfig> |
getMediaSourceList()
Returns the list of MediaSourceConfig objects. |
NavigationStateBuilder |
getNavigationStateBuilder()
Returns the NavigationStateBuilder that will be used by the LinkBuilder to create a navigation state and generate links. |
void |
preprocess(MediaBannerConfig config)
Verifies the configuration for this handler. |
MediaBanner |
process(MediaBannerConfig config)
Creates a response model of the form: |
void |
setContentSource(ContentSource contentSource)
Sets the content source that will be used to create Action objects. |
void |
setMediaSourceList(List<MediaSourceConfig> mediaSrcList)
Sets the list of MediaSourceConfig objects. |
void |
setNavigationStateBuilder(NavigationStateBuilder navigationStateBuilder)
Sets the NavigationStateBuilder |
protected MediaBannerConfig |
wrapConfig(ContentItem pContentItem)
Wraps the input ContentItem as a typed config object. |
Methods inherited from class com.endeca.infront.cartridge.NavigationCartridgeHandler |
---|
createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, initialize, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MediaBannerHandler()
Method Detail |
---|
public NavigationStateBuilder getNavigationStateBuilder()
public void setNavigationStateBuilder(NavigationStateBuilder navigationStateBuilder)
getNavigationStateBuilder()
public List<MediaSourceConfig> getMediaSourceList()
MediaSourceConfig
objects.
CartridgeHandlerException
will be thrown from preprocess(com.endeca.infront.cartridge.MediaBannerConfig)
.public void setMediaSourceList(List<MediaSourceConfig> mediaSrcList)
MediaSourceConfig
objects.
getMediaSourceList()
public ContentSource getContentSource()
Action
objects.
public void setContentSource(ContentSource contentSource)
Action
objects.
public void preprocess(MediaBannerConfig config) throws CartridgeHandlerException
preprocess
in interface CartridgeHandler<MediaBannerConfig>
preprocess
in class NavigationCartridgeHandler<MediaBannerConfig,MediaBanner>
config
- the cartridge configuration returned by
CartridgeHandler.initialize(ContentItem)
. This cartridge configuration may
be modified by this handler. Note that this cartridge configuration is
also passed to CartridgeHandler.process(ContentItem)
.
CartridgeHandlerException
- if mediaSourceList
, navigationStateBuilder
,
or mdexResource
have not been set. Also throws an exception if the
MediaBannerConfig
is not valid.getMediaSourceList()
public MediaBanner process(MediaBannerConfig config) throws CartridgeHandlerException
{ link:LinkBuilder
, media:MediaObject
}
process
in interface CartridgeHandler<MediaBannerConfig>
process
in class NavigationCartridgeHandler<MediaBannerConfig,MediaBanner>
config
- the cartridge configuration returned by
CartridgeHandler.initialize(ContentItem)
. Note that this instance may have been modified by
the CartridgeHandler.preprocess(ContentItem)
method.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance. This exception will not halt
the entire assembly process, which occurs across multiple cartridges;
instead, this exception will be packaged in the overall response model.
If an unchecked exception is thrown, then the entire assembly process
will be halted.protected MediaBannerConfig wrapConfig(ContentItem pContentItem)
NavigationCartridgeHandler
ContentItem
as a typed config object. It is not expected that
subclasses will mutate the input ContentItem
, beyond passing it into
their typed configuration class as a constructor argument.
wrapConfig
in class NavigationCartridgeHandler<MediaBannerConfig,MediaBanner>
pContentItem
- the configuration for this cartridge handler. This will either be the
fully initialized configuration object, if a ContentItemInitializer
has been
set, or it will simply be the instance configuration.
ConfigType
which wraps the input ContentItem
.NavigationCartridgeHandler.initialize(ContentItem)
,
NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |