01: /* ***** BEGIN LICENSE BLOCK *****
02: * Version: MPL 1.1
03: * The contents of this file are subject to the Mozilla Public License Version
04: * 1.1 (the "License"); you may not use this file except in compliance with
05: * the License. You may obtain a copy of the License at
06: * http://www.mozilla.org/MPL/
07: *
08: * Software distributed under the License is distributed on an "AS IS" basis,
09: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10: * for the specific language governing rights and limitations under the
11: * License.
12: *
13: * The Original Code is Riot.
14: *
15: * The Initial Developer of the Original Code is
16: * Neteye GmbH.
17: * Portions created by the Initial Developer are Copyright (C) 2007
18: * the Initial Developer. All Rights Reserved.
19: *
20: * Contributor(s):
21: * Felix Gnass [fgnass at neteye dot de]
22: *
23: * ***** END LICENSE BLOCK ***** */
24: package org.riotfamily.components.locator;
25:
26: import javax.servlet.http.HttpServletRequest;
27:
28: import org.riotfamily.components.controller.render.InheritingRenderStrategy;
29: import org.riotfamily.components.model.Location;
30:
31: /**
32: * Interface that returns the {@link Location} of the ComponentList that should
33: * be rendered.
34: *
35: * @author Felix Gnass [fgnass at neteye dot de]
36: * @since 6.5
37: */
38: public interface ComponentListLocator {
39:
40: /**
41: * Returns whether the locator supports the given type.
42: * @see Location#getType()
43: */
44: public boolean supports(String type);
45:
46: /**
47: * Returns the {@link Location} for the given request.
48: */
49: public Location getLocation(HttpServletRequest request);
50:
51: /**
52: * Returns the location that should be used to display inherited components.
53: * @see InheritingRenderStrategy
54: */
55: public Location getParentLocation(Location location);
56:
57: /**
58: * Returns the URL under which the given location can be seen.
59: */
60: public String getUrl(Location location);
61:
62: }
|