org.apache.wicket.request.handler.IPageProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation
Show all versions of org.ops4j.pax.wicket.service Show documentation
Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and
unloading of Wicket components and pageSources.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.request.handler;
import org.apache.wicket.protocol.http.PageExpiredException;
import org.apache.wicket.request.component.IRequestablePage;
import org.apache.wicket.request.mapper.StalePageException;
import org.apache.wicket.request.mapper.parameter.PageParameters;
/**
* Represents object capable of providing a page instance. In some cases the implementation class
* might now page class and page parameters without having the actual page instance. Thus it's
* recommended to call {@link #getPageParameters()} instead of calling {@link #getPageInstance()}
* .getPageParameters(). Same goes for page class.
*
* @author Matej Knopp
*/
public interface IPageProvider
{
/**
* Returns page instance specified by the constructor.
*
* @return page instance
* @throws StalePageException
* if render count has been specified in constructor and the render count of page
* does not match the value
* @throws {@link PageExpiredException} if the specified page could not have been found and the
* constructor used did not provide enough information to create new page instance
*/
IRequestablePage getPageInstance();
/**
* Returns {@link PageParameters} of the page.
*
* @return page parameters
*/
PageParameters getPageParameters();
/**
* Returns whether calling getPageInstance() will result in creating new page instance or
* whether it will be an existing instance (even though it might be pulled from page store).
*
* @return true
if calling {@link #getPageInstance()} will create new page
* instance, false
otherwise.
*/
boolean isNewPageInstance();
/**
* Returns class of the page.
*
* @return page class
*/
Class extends IRequestablePage> getPageClass();
/**
* Returns the page id.
*
* @return page id
*/
Integer getPageId();
/**
* Returns the number of times this page has been rendered.
*
* @return the number of times this page has been rendered.
*/
Integer getRenderCount();
/**
* Detaches the page if it has been loaded.
*/
void detach();
/**
* Checks whether or not the provider has a page instance. This page instance might have been
* passed to this page provider directly or it may have been instantiated or retrieved from the
* page store.
*
* @return {@code true} iff page instance has been created or retrieved
*/
// TODO wicket.next add this method to the interface
// public final boolean hasPageInstance();
/**
* Returns whether or not the page instance held by this provider has been instantiated by the
* provider.
*
* @throws IllegalStateException
* if this method is called and the provider does not yet have a page instance, ie
* if {@link #getPageInstance()} has never been called on this provider
* @return {@code true} iff the page instance held by this provider was instantiated by the
* provider
*/
// TODO wicket.next add this method to the interface
// public final boolean isPageInstanceFresh();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy