org.springframework.extensions.surf.extensibility

Interface SubComponentEvaluator

All Superinterfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

All Known Implementing Classes:

DefaultSubComponentEvaluator, RejectionSubComponentEvaluator

public interface SubComponentEvaluator
extends org.springframework.beans.factory.BeanNameAware

A SubComponentEvaluator is used to help evaluate whether or not a SubComponent should be rendered or not. One or more SubComponentEvaluators are called upon by a SubComponentEvaluation to determine whether a SubComponent should be rendered. If the evaluate method of every SubComponentEvaluator returns true the the SubComponent will be rendered.

Each SubComponentEvaluator implementation should be configured as a Spring bean in the application context and it's bean id should be referenced in the Component or ModuleDeployment configuration (depending upon whether or not it is being defined as part of base or extension configuration.

Author:

David Draper

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(RequestContext context, Map<String,String> params) Evaluates whether or not the information in the supplied RequestContext meets the criteria defined in the supplied parameter Map.

Methods inherited from interface org.springframework.beans.factory.BeanNameAware

setBeanName

Method Detail

evaluate

boolean evaluate(RequestContext context,
               Map<String,String> params)

Evaluates whether or not the information in the supplied RequestContext meets the criteria defined in the supplied parameter Map.

Parameters:

context - The RequestContext currently being serviced.

params - A Map of name/value parameters that define the evaluation criteria.

Returns:

true if the evaluation passes and false otherwise.