KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > resolver > PageSpecificationResolver


1 // Copyright 2004, 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.tapestry.resolver;
16
17 import org.apache.tapestry.INamespace;
18 import org.apache.tapestry.IRequestCycle;
19 import org.apache.tapestry.spec.IComponentSpecification;
20
21 /**
22  * Service interface for locating a page specification given its name.
23  *
24  * @author Howard Lewis Ship
25  * @since 4.0
26  */
27 public interface PageSpecificationResolver
28 {
29     /**
30      * Resolve the name (which may have a library id prefix) to a namespace (see
31      * {@link #getNamespace()}) and a specification (see {@link #getSpecification()}).
32      *
33      * @throws org.apache.tapestry.PageNotFoundException
34      * if the name cannot be resolved to the name of a page
35      */
36     public void resolve(IRequestCycle cycle, String JavaDoc prefixedName);
37
38     /**
39      * Returns just the name of the page, unqualified by any namespace.
40      */
41     public String JavaDoc getSimplePageName();
42
43     /**
44      * Returns the namespace containing the page.
45      */
46     public INamespace getNamespace();
47
48     /**
49      * Returns the specification for the page.
50      */
51     public IComponentSpecification getSpecification();
52 }
Popular Tags