01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.wicket.extensions.wizard;
18:
19: import org.apache.wicket.IClusterable;
20:
21: /**
22: * Interface for the wizard component. This interface is here for ultimate
23: * flexibility, though it doesn't guarantee much. Typically, you would extend
24: * from {@link Wizard the default wizard component} instead of implementing this
25: * interface directly.
26: *
27: * <p>
28: * Part of the contract of wizards is that {@link IWizardStep wizard steps} are
29: * initialized when the wizard receives the {@link IWizardModel wizard model}.
30: * </p>
31: *
32: * @author Eelco Hillenius
33: */
34: public interface IWizard extends IClusterable {
35: /**
36: * Gets the model this wizard is using. This should never be null; a wizard
37: * is supposed to have a model.
38: *
39: * @return The wizard model.
40: */
41: IWizardModel getWizardModel();
42: }
|