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.model;
18:
19: /**
20: * Models that implement this interface will support chaining of IModels.
21: * getObject() of a IChainingModel should do something like:
22: * <pre>
23: * if ( object instanceof IModel) { return ((IModel)object).getObject()}
24: * else return object;
25: * </pre>
26: *
27: * ChainingModels should also take care that the internal model detach is called
28: * when detach is called on them.
29: *
30: * @author jcompagner
31: * @author Igor Vaynberg (ivaynberg)
32: *
33: * @see CompoundPropertyModel
34: * @see AbstractPropertyModel
35: */
36: public interface IChainingModel extends IModel {
37: /**
38: * Sets the model that is chained inside this model.
39: *
40: * @param model
41: */
42: public void setChainedModel(IModel model);
43:
44: /**
45: * Returns the chained model if there is a chained model.
46: *
47: * @return The chained model
48: */
49: public IModel getChainedModel();
50:
51: }
|