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;
016
017/**
018 * Defines a page which may be referenced externally via a URL using the
019 * {@link org.apache.tapestry.engine.ExternalService}. External pages may be bookmarked via their
020 * URL for latter display. See the {@link org.apache.tapestry.link.ExternalLink}for details on how
021 * to invoke <tt>IExternalPage</tt>s.
022 * 
023 * @see org.apache.tapestry.callback.ExternalCallback
024 * @see org.apache.tapestry.engine.ExternalService
025 * @author Howard Lewis Ship
026 * @author Malcolm Edgar
027 * @since 2.2
028 */
029
030public interface IExternalPage extends IPage
031{
032    /**
033     * Initialize the external page with the given array of parameters and request cycle.
034     * <p>
035     * This method is invoked after {@link IPage#validate(IRequestCycle)}.
036     * 
037     * @param parameters
038     *            the array of listener parameters
039     * @param cycle
040     *            current request cycle
041     */
042
043    public void activateExternalPage(Object[] parameters, IRequestCycle cycle);
044}