atg.projects.store.actor
Class ActorExecutor

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.projects.store.actor.ActorExecutor

All Implemented Interfaces:

atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class ActorExecutor
extends atg.nucleus.GenericService

Invokes an Actor and makes a ContentItem available to the Actor with the contentItemPropertyName key.

Version:

$Change: 794719 $$DateTime: 2013/03/05 08:52:29 $$Author: jsiddaga $

Author:

cbarthle

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

ActorExecutor()

Method Summary

atg.service.actor.ActorContextFactory	getActorContextFactory()
java.lang.String	getContentItemPropertyName() The key of the content item property available to the actor.
atg.service.actor.ModelMapFactory	getModelMapFactory()
java.lang.String	getOutputModelPropertyName() The property name in ContentItem of the actor output
com.endeca.infront.assembler.ContentItem	invokeActor(atg.service.actor.Actor pActor, com.endeca.infront.assembler.ContentItem pContentItem) Invokes the given actor.
void	setActorContextFactory(atg.service.actor.ActorContextFactory pActorContextFactory)
void	setContentItemPropertyName(java.lang.String pContentItemPropertyName) Sets the key for the content item property.
void	setModelMapFactory(atg.service.actor.ModelMapFactory pModelMapFactory)
void	setOutputModelPropertyName(java.lang.String pOutputModelPropertyName) Sets the property name in ContentItem of the actor output

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

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

Class version string

See Also:

Constant Field Values

Constructor Detail

ActorExecutor

public ActorExecutor()

Method Detail

getModelMapFactory

public atg.service.actor.ModelMapFactory getModelMapFactory()

See Also:

ModelMapFactory

setModelMapFactory

public void setModelMapFactory(atg.service.actor.ModelMapFactory pModelMapFactory)

See Also:

ModelMapFactory

getActorContextFactory

public atg.service.actor.ActorContextFactory getActorContextFactory()

See Also:

ActorContextFactory

setActorContextFactory

public void setActorContextFactory(atg.service.actor.ActorContextFactory pActorContextFactory)

See Also:

ActorContextFactory

getContentItemPropertyName

public java.lang.String getContentItemPropertyName()

The key of the content item property available to the actor.

Returns:

the contentItemPropertyName

setContentItemPropertyName

public void setContentItemPropertyName(java.lang.String pContentItemPropertyName)

Sets the key for the content item property.

Parameters:

pContentItemPropertyName - the contentItemPropertyName to set

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

invokeActor

public com.endeca.infront.assembler.ContentItem invokeActor(atg.service.actor.Actor pActor,
                                                            com.endeca.infront.assembler.ContentItem pContentItem)

Invokes the given actor. The ContentItem is made avaialble in the actor context. The Actor output model map is then added to the ContentItem.

Parameters:

pActor - The actor to invoke

pContentItem - The ContentItem to update

Returns:

The updated content item