org.apache.wicket.model.IChainingModel 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

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.0

Show newest version

/*
 * 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.model;

/**
 * Models that implement this interface will support chaining of IModels. getObject() of a
 * IChainingModel should do something like:
 * 
 *  * if ( object instanceof IModel) { return ((IModel)object).getObject()}
 * else return object;
 * 
 * 
 * ChainingModels should also take care that the internal model detach is called when detach is
 * called on them.
 * 
 * @author jcompagner
 * @author Igor Vaynberg (ivaynberg)
 * 
 * @param 
 *            The Model object type
 * 
 * @see CompoundPropertyModel
 * @see AbstractPropertyModel
 */
public interface IChainingModel extends IModel
{
	/**
	 * Sets the model that is chained inside this model.
	 * 
	 * @param model
	 */
	public void setChainedModel(IModel model);

	/**
	 * Returns the chained model if there is a chained model.
	 * 
	 * @return The chained model
	 */
	public IModel getChainedModel();

}