001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.core.request.mapper;
018
019import org.apache.wicket.request.component.IRequestablePage;
020import org.apache.wicket.request.mapper.parameter.PageParameters;
021
022/**
023 * Interface for objects that are capable of getting and creating page instance.
024 *
025 * @author Matej Knopp
026 */
027public interface IPageSource
028{
029        /**
030         * Returns existing page instance if the page exists.
031         *
032         * @param pageId
033         * @return page instance or <code>null</code> if the page does not exist.
034         */
035        IRequestablePage getPageInstance(int pageId);
036
037        /**
038         * Creates new page instance of page with given class. The page should be marked as create
039         * bookmarkable, so subsequent calls to {@link IRequestablePage#wasCreatedBookmarkable()} must
040         * return <code>true</code>
041         *
042         * @param pageClass
043         * @param pageParameters
044         * @return new page instance
045         */
046        IRequestablePage newPageInstance(Class<? extends IRequestablePage> pageClass,
047                PageParameters pageParameters);
048
049}