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
015package org.apache.tapestry.resolver;
016
017import org.apache.tapestry.INamespace;
018import org.apache.tapestry.IRequestCycle;
019import 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 */
027public interface PageSpecificationResolver
028{
029    /**
030     * Resolve the name (which may have a library id prefix) to a namespace (see
031     * {@link #getNamespace()}) and a specification (see {@link #getSpecification()}).
032     * 
033     * @throws org.apache.tapestry.PageNotFoundException
034     *             if the name cannot be resolved to the name of a page
035     */
036    public void resolve(IRequestCycle cycle, String prefixedName);
037
038    /**
039     * Returns just the name of the page, unqualified by any namespace.
040     */
041    public String getSimplePageName();
042
043    /**
044     * Returns the namespace containing the page.
045     */
046    public INamespace getNamespace();
047
048    /**
049     * Returns the specification for the page.
050     */
051    public IComponentSpecification getSpecification();
052}