org.apache.wicket.model
Interface IModel

All Superinterfaces:

IClusterable, IDetachable, java.io.Serializable

All Known Subinterfaces:

IChainingModel, IComponentAssignedModel, IComponentInheritedModel, IObjectClassAwareModel, IWrapModel

All Known Implementing Classes:

AbstractCheckBoxModel, AbstractPropertyModel, AbstractReadOnlyModel, AbstractWrapModel, BoundCompoundPropertyModel, ComponentDetachableModel, ComponentModel, ComponentPropertyModel, CompoundPropertyModel, ContactDetachableModel, DetachableContactModel, DirectModel, FeedbackMessagesModel, ListItemModel, LoadableDetachableModel, Model, PropertyModel, ProxyModel, ProxyModel, ResourceModel, StringResourceModel

public interface IModel
extends IDetachable

A IModel wraps the actual model Object used by a Component. IModel implementations are used as a facade for the real model so that users have control over the actual persistence strategy. Note that objects implementing this interface will be stored in the Session. Hence, you should use (non-transient) instance variables sparingly.

• Basic Models - To implement a basic (non-detachable) model which holds its entire state in the Session, you can either subclass AbstractModel, or use the simple model wrapper Model directly.
• Detachable Models - IModel inherits a hook, IDetachable.detach(), so that interface implementers can detach transient information when a model is no longer being actively used by the framework. This reduces memory use and reduces the expense of replicating the model in a clustered server environment. To implement a detachable model, you should generally extend org.apache.wicket.model.AbstractDetachableModelinstead of implementing IModel directly.
• Property Models - The AbstractPropertyModel class provides default functionality for property models. A property model provides access to a particular property of its wrapped model.
• Compound Property Models - The IModel interface is parameterized by Component, allowing a model to be shared among several Components. When the getObject()method is called, the value returned will depend on the Component which is asking for the value. Likewise, the setObject(Object)method sets a different property depending on which Component is doing the setting. For more information on CompoundPropertyModels and model inheritance, see CompoundPropertyModeland Page.

Author:

Chris Turner, Eelco Hillenius, Jonathan Locke TODO 3.0: Vote on renaming get/setObject to get/setValue

See Also:

Component.sameInnermostModel(org.apache.wicket.Component), Component.sameInnermostModel(IModel)

Method Summary

java.lang.Object	getObject() Gets the model object.
void	setObject(java.lang.Object object) Sets the model object.

Methods inherited from interface org.apache.wicket.model.IDetachable

detach

Method Detail

getObject

java.lang.Object getObject()

Gets the model object.

Returns:

The model object

setObject

void setObject(java.lang.Object object)

Sets the model object.

Parameters:

object - The model object