01: /*
02: * Created on 19 Sep 2006
03: */
04: package uk.org.ponder.rsf.templateresolver;
05:
06: /** An superinterface for a TemplateResolverStrategy that explicitly participates
07: * in root resolution. A TRS that does *not* implement this interface will have
08: * inferred a default priority of <code>1</code>
09: * @author Antranig Basman (antranig@caret.cam.ac.uk)
10: *
11: */
12: public interface RootAwareTRS extends TemplateResolverStrategy {
13: /**
14: * Returns positive numbers if this is a resolver for root templates (i.e.
15: * those at which rendering begins for a view). The highest value
16: * of resolver priority found for a particular request will be used to
17: * determine the template actually used to render the root. <br>
18: * A value of "0" indicates this template should *never* be used as a root
19: * template.
20: * <p>
21: * A value of "1" is a default value given to various framework interfaces
22: * (such as {@link CRITemplateResolverStrategy}) that *should in general* be
23: * root templates.
24: * <p>
25: * User code should use a value of "2" or more to take priority over framework
26: * defaults, where they want to override the default choice of root template.
27: */
28: public int getRootResolverPriority();
29: }
|