|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.infront.cartridge.ContentSlotListHandler
public class ContentSlotListHandler
Cartridge handler that provides a pass through for ContentSlotListConfig
objects.
Constructor Summary | |
---|---|
ContentSlotListHandler()
|
Method Summary | |
---|---|
ContentItemInitializer |
getContentItemInitializer()
Returns the ContentItemInitializer used to create the full cartridge
configuration. |
ContentSlotListConfig |
initialize(ContentItem pContentItem)
Uses the ContentItemInitializer , if one has been set,
to create the full configuration for this cartridge. |
void |
preprocess(ContentSlotListConfig pContentItem)
Does nothing. |
ContentItem |
process(ContentSlotListConfig pContentItem)
Returns the input ContentSlotListConfig . |
void |
setContentItemInitializer(ContentItemInitializer initializer)
Sets the ContentItemInitializer used to create the full cartridge
configuration in the initialize(com.endeca.infront.assembler.ContentItem) method. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContentSlotListHandler()
Method Detail |
---|
public void setContentItemInitializer(ContentItemInitializer initializer)
ContentItemInitializer
used to create the full cartridge
configuration in the initialize(com.endeca.infront.assembler.ContentItem)
method. If the initializer is null,
the initialize(com.endeca.infront.assembler.ContentItem)
method will simply wrap the input ContentItem
as an instance of the handler's configuration type and return it.
initializer
- may be nullCartridgeHandler.initialize(ContentItem)
public ContentItemInitializer getContentItemInitializer()
ContentItemInitializer
used to create the full cartridge
configuration.
setContentItemInitializer(ContentItemInitializer)
public ContentSlotListConfig initialize(ContentItem pContentItem) throws CartridgeHandlerException
ContentItemInitializer
, if one has been set,
to create the full configuration for this cartridge. If no
ContentItemInitializer
has been set, simply wraps the input
ContentItem
.
initialize
in interface CartridgeHandler<ContentSlotListConfig>
pContentItem
- cartridge instance configuration, typically
from Experience Manager.
preprocess(com.endeca.infront.cartridge.ContentSlotListConfig)
or process(com.endeca.infront.cartridge.ContentSlotListConfig)
methods.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance (for instance, the handler is unable to access its
default configuration). 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.setContentItemInitializer(ContentItemInitializer)
public void preprocess(ContentSlotListConfig pContentItem) throws CartridgeHandlerException
preprocess
in interface CartridgeHandler<ContentSlotListConfig>
pContentItem
- 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 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.public ContentItem process(ContentSlotListConfig pContentItem) throws CartridgeHandlerException
ContentSlotListConfig
.
process
in interface CartridgeHandler<ContentSlotListConfig>
pContentItem
- 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |