com.tsgrp.opencontent.core.action.service

Interface IActionService

All Known Implementing Classes:

CoreActionService, MockActionService

public interface IActionService

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	buildRequestInfo(javax.servlet.http.HttpServletRequest request) Constructs a Map that contains all of the information stored on the HttpServletRequest
void	evaluateAction(java.lang.String ticket, Action action, EvaluationCache evalCache, java.util.Map<java.lang.String,java.lang.Object> requestInfo) Evaluates the Action with the given EvaluationCache.
void	evaluateAction(java.lang.String ticket, Action action, java.util.Map<java.lang.String,java.lang.Object> requestInfo) Evaluates the action and creates a new EvaluationCache.
void	evaluateActions(java.lang.String ticket, java.util.List<Action> actions, java.util.Map<java.lang.String,java.lang.Object> requestInfo) Evaluates a list of actions
Condition	evaluateCondition(java.lang.String ticket, java.lang.String conditionBeanId, java.lang.String nodeId, java.lang.String[] nodeIds, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.Map<java.lang.String,java.lang.Object> requestInfo) This method evaluates the supplied nodeId against the supplied conditionBeanIds, returning the Condition (with valid or invalid status)
java.util.List<Condition>	evaluateConditions(java.lang.String ticket, java.util.List<java.lang.String> conditionBeanIds, java.lang.String nodeId, java.lang.String[] nodeIds, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.Map<java.lang.String,java.lang.Object> requestInfo) See #evaluateCondition(String, String, String)
void	execute(java.lang.String ticket, Action action, java.util.Map<java.lang.String,java.lang.Object> requestInfo) Executes an action
java.lang.String	executeAsThread(java.lang.String ticket, Action action, java.util.Map<java.lang.String,java.lang.Object> requestInfo) Executes an action in a new thread
ActionDefinition	getActionDefinition(java.lang.String actionId) Retrieve the ActionDefinition based on the action id
java.util.Map<java.lang.String,ActionExecuter>	getAvailableActions(java.lang.String ticket) Retrieve the available actions
java.util.Map<java.lang.String,java.lang.String>	getAvailableConditions(java.lang.String ticket) Return a map of all available conditions currently configured in this webapp's Spring context.
ConditionEvaluator	getConditionEvaluator(java.lang.String conditionName) Retrieve the condition evaluator based on teh condition name
boolean	isActionValid(java.lang.String ticket, Action action, java.util.Map<java.lang.String,java.lang.Object> requestInfo) Returns whether or not the Action is valid.

Method Detail

getActionDefinition

ActionDefinition getActionDefinition(java.lang.String actionId)

Retrieve the ActionDefinition based on the action id

Parameters:

actionId - the Action ID

Returns:

the ActionDefinition or null if it doesn't excist

getConditionEvaluator

ConditionEvaluator getConditionEvaluator(java.lang.String conditionName)
                                  throws NoSuchConditionException

Retrieve the condition evaluator based on teh condition name

Parameters:

conditionName -

Returns:

the ConditionEvaluator or null if it does not exist

Throws:

NoSuchConditionException

evaluateAction

void evaluateAction(java.lang.String ticket,
                    Action action,
                    EvaluationCache evalCache,
                    java.util.Map<java.lang.String,java.lang.Object> requestInfo)

Evaluates the Action with the given EvaluationCache.

Parameters:

ticket -

action -

evalCache -

requestInfo -

evaluateAction

void evaluateAction(java.lang.String ticket,
                    Action action,
                    java.util.Map<java.lang.String,java.lang.Object> requestInfo)

Evaluates the action and creates a new EvaluationCache.

Parameters:

ticket -

action -

requestInfo -

evaluateActions

void evaluateActions(java.lang.String ticket,
                     java.util.List<Action> actions,
                     java.util.Map<java.lang.String,java.lang.Object> requestInfo)

Evaluates a list of actions

Parameters:

ticket -

actions -

requestInfo -

isActionValid

boolean isActionValid(java.lang.String ticket,
                      Action action,
                      java.util.Map<java.lang.String,java.lang.Object> requestInfo)

Returns whether or not the Action is valid. Note, this method will evaluate the actions if one of the evauluate* methods have not yet been called. * @param ticket

Parameters:

action -

requestInfo -

Returns:

execute

void execute(java.lang.String ticket,
             Action action,
             java.util.Map<java.lang.String,java.lang.Object> requestInfo)

Executes an action

Parameters:

ticket -

action -

requestInfo -

executeAsThread

java.lang.String executeAsThread(java.lang.String ticket,
                                 Action action,
                                 java.util.Map<java.lang.String,java.lang.Object> requestInfo)

Executes an action in a new thread

Parameters:

ticket -

action -

requestInfo -

Returns:

getAvailableActions

java.util.Map<java.lang.String,ActionExecuter> getAvailableActions(java.lang.String ticket)

Retrieve the available actions

Parameters:

ticket -

Returns:

evaluateCondition

Condition evaluateCondition(java.lang.String ticket,
                            java.lang.String conditionBeanId,
                            java.lang.String nodeId,
                            java.lang.String[] nodeIds,
                            java.util.Map<java.lang.String,java.lang.Object> parameters,
                            java.util.Map<java.lang.String,java.lang.Object> requestInfo)

This method evaluates the supplied nodeId against the supplied conditionBeanIds, returning the Condition (with valid or invalid status)

Parameters:

ticket -

conditionBeanId -

nodeId -

nodeIds -

parameters -

requestInfo -

Returns:

evaluateConditions

java.util.List<Condition> evaluateConditions(java.lang.String ticket,
                                             java.util.List<java.lang.String> conditionBeanIds,
                                             java.lang.String nodeId,
                                             java.lang.String[] nodeIds,
                                             java.util.Map<java.lang.String,java.lang.Object> parameters,
                                             java.util.Map<java.lang.String,java.lang.Object> requestInfo)

See #evaluateCondition(String, String, String)

Parameters:

ticket -

conditionBeanIds -

nodeId -

nodeIds -

parameters -

requestInfo -

Returns:

getAvailableConditions

java.util.Map<java.lang.String,java.lang.String> getAvailableConditions(java.lang.String ticket)

Return a map of all available conditions currently configured in this webapp's Spring context.

Parameters:

ticket -

Returns:

buildRequestInfo

java.util.Map<java.lang.String,java.lang.Object> buildRequestInfo(javax.servlet.http.HttpServletRequest request)

Constructs a Map that contains all of the information stored on the HttpServletRequest

Parameters:

request -

Returns: