atg.service.actor

Interface Actor

All Known Subinterfaces:

VariantActor

All Known Implementing Classes:

ActorChainService

public interface Actor

The actors behaves as a controller in the MVC paradigm. It helps generate a model (a map of maps called a ModelMap). Each actor implementation implements this Actor interface.

The actor is a doer. The doer is the one when called, it acts and gets things done. The actor implementation does whatever the actor needs to do and if necessary updates the model map .

Each actor delegates to a resource - a JSP page, form handler, droplet, component or another chain of actors. These are few OTB examples of actors. But this interface could be implemented for some other purposes as well.

The Actor implementation should make sure that ActorContext and ModelMap are non-null.

See Also:

The Form actor supports html form related features, The Component actor supports component related features.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
void	act(ActorContext pActorContext, ModelMap pModelMap) This method takes a non-null ModelMap and a non-null context called an ActorContext.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

act

void act(ActorContext pActorContext,
         ModelMap pModelMap)
  throws ActorException

This method takes a non-null ModelMap and a non-null context called an ActorContext. The Actor implementation should make sure that ActorContext and ModelMap are non-null.

Parameters:

pActorContext - The ActorContext is a map where attributes can be passed into the actor.

pModelMap - A map that contains models

Throws:

ActorException - If there is any error, this exception is thrown.