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.extensions.wizard;
018
019import org.apache.wicket.util.io.IClusterable;
020
021/**
022 * Interface for the wizard component. This interface is here for ultimate flexibility, though it
023 * doesn't guarantee much. Typically, you would extend from {@link Wizard the default wizard
024 * component} instead of implementing this interface directly.
025 * 
026 * <p>
027 * Part of the contract of wizards is that {@link IWizardStep wizard steps} are initialized when the
028 * wizard receives the {@link IWizardModel wizard model}.
029 * </p>
030 * 
031 * @author Eelco Hillenius
032 */
033public interface IWizard extends IClusterable
034{
035        /**
036         * Gets the model this wizard is using. This should never be null; a wizard is supposed to have
037         * a model.
038         * 
039         * @return The wizard model.
040         */
041        IWizardModel getWizardModel();
042}