001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.resolver;
016    
017    import org.apache.tapestry.INamespace;
018    import org.apache.tapestry.IRequestCycle;
019    import org.apache.tapestry.spec.IComponentSpecification;
020    
021    /**
022     * Service interface for locating a page specification given its name.
023     * 
024     * @author Howard Lewis Ship
025     * @since 4.0
026     */
027    public interface PageSpecificationResolver
028    {
029    
030        /**
031         * Resolve the name (which may have a library id prefix) to a namespace (see
032         * {@link #getNamespace()}) and a specification (see
033         * {@link #getSpecification()}).
034         * 
035         * @throws org.apache.tapestry.PageNotFoundException
036         *             if the name cannot be resolved to the name of a page
037         */
038        void resolve(IRequestCycle cycle, String prefixedName);
039    
040        /**
041         * Returns just the name of the page, unqualified by any namespace.
042         */
043        String getSimplePageName();
044    
045        /**
046         * Returns the namespace containing the page.
047         */
048        INamespace getNamespace();
049    
050        /**
051         * Returns the specification for the page.
052         */
053        IComponentSpecification getSpecification();
054    }