atg.projects.store.assembler.cartridge.handler

Class ActorInvokingCartridgeHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,com.endeca.infront.assembler.ContentItem>

atg.projects.store.assembler.cartridge.handler.ActorInvokingCartridgeHandler

All Implemented Interfaces:

com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.assembler.ContentItem>

Direct Known Subclasses:

ProductListCategoryChildrenHandler

public class ActorInvokingCartridgeHandler
extends com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,com.endeca.infront.assembler.ContentItem>

ActorInvokingCartridgeHandler - this cartridge invokes a user specified Actor in the process() method and passes the Actor parameters defined in the contentItemAdditionsMap property

Properties:

• actorToInvoke - the Actor that will be invoked in the process method. ex: /atg/endeca/assembler/cartridge/actor/HomepageTargetedItemsActor
• actorExecutor - the ActorExecutor that will invoke the actorToInvoke
• contentItemAdditionsMap - ResolvingMap of properties that will be put into the ContentItem passed to the wrapConfig method. Essentially, these are properties that will be passed to actorToInvoke through the ContentItem

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/Endeca/Assembler/src/atg/projects/store/assembler/cartridge/handler/ActorInvokingCartridgeHandler.java#1 $$Change: 1385662 $

Author:

Yekaterina Kostenevich

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
ActorInvokingCartridgeHandler()

Method Summary

Modifier and Type	Method and Description
atg.service.actor.ActorExecutor	getActorExecutor()
atg.service.actor.Actor	getActorToInvoke()
atg.nucleus.ResolvingMap	getContentItemAdditionsMap()
java.lang.String	getOutputModelPropertyName() The property name in ContentItem of the actor output
com.endeca.infront.assembler.ContentItem	process(com.endeca.infront.assembler.ContentItem pCartridgeConfig) This method invokes the actor "actorToInvoke." The properties set in "contentItemsAdditionsMap" will be passed to the actor in "currentContentItem."
void	setActorExecutor(atg.service.actor.ActorExecutor pActorExecutor)
void	setActorToInvoke(atg.service.actor.Actor pActorToInvoke)
void	setContentItemAdditionsMap(atg.nucleus.ResolvingMap pContentItemAdditionsMap)
void	setOutputModelPropertyName(java.lang.String pOutputModelPropertyName) Sets the property name in ContentItem of the actor output
protected com.endeca.infront.assembler.ContentItem	wrapConfig(com.endeca.infront.assembler.ContentItem pContentItem) Create a new BasicContentItem using the passed in ContentItem.

Methods inherited from class com.endeca.infront.cartridge.NavigationCartridgeHandler

createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, executeMdexRequest, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, getUserState, initialize, populateNavigationPathDefaults, preprocess, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState, setSiteState, setUserState

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

ActorInvokingCartridgeHandler

public ActorInvokingCartridgeHandler()

Method Detail

getActorExecutor

public atg.service.actor.ActorExecutor getActorExecutor()

Returns:

the actorExecutor

setActorExecutor

public void setActorExecutor(atg.service.actor.ActorExecutor pActorExecutor)

Parameters:

pActorExecutor - the actorExecutor to set

getActorToInvoke

public atg.service.actor.Actor getActorToInvoke()

Returns:

the ActorToInvoke

setActorToInvoke

public void setActorToInvoke(atg.service.actor.Actor pActorToInvoke)

Parameters:

pActorToInvoke - the actor that will be invoked in the process method

getContentItemAdditionsMap

public atg.nucleus.ResolvingMap getContentItemAdditionsMap()

Returns:

A map whose keys are cartridge types and whose values are handler components.

setContentItemAdditionsMap

public void setContentItemAdditionsMap(atg.nucleus.ResolvingMap pContentItemAdditionsMap)

Parameters:

pContentItemAdditionsMap - Set a new ContentItemAdditionsMap map

getOutputModelPropertyName

public java.lang.String getOutputModelPropertyName()

The property name in ContentItem of the actor output

Returns:

the outputModelPropertyName

setOutputModelPropertyName

public void setOutputModelPropertyName(java.lang.String pOutputModelPropertyName)

Sets the property name in ContentItem of the actor output

Parameters:

pOutputModelPropertyName - the outputModelPropertyName to set

wrapConfig

protected com.endeca.infront.assembler.ContentItem wrapConfig(com.endeca.infront.assembler.ContentItem pContentItem)

Create a new BasicContentItem using the passed in ContentItem. The map defined in the properties file will be put into the BasicContentItem

Specified by:

wrapConfig in class com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,com.endeca.infront.assembler.ContentItem>

Parameters:

pContentItem - The cartridge content item to be wrapped.

Returns:

a new TargetedItems configuration.

process

public com.endeca.infront.assembler.ContentItem process(com.endeca.infront.assembler.ContentItem pCartridgeConfig)

This method invokes the actor "actorToInvoke." The properties set in "contentItemsAdditionsMap" will be passed to the actor in "currentContentItem."

Specified by:

process in interface com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.assembler.ContentItem>

Overrides:

process in class com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.assembler.ContentItem,com.endeca.infront.assembler.ContentItem>

Parameters:

pCartridgeConfig - ContentItem to pass to the actor

Returns:

A fully configured ContentItem.