org.fujion.model.IModelAndView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fujion-core Show documentation
There is a newer version: 3.1.0
/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2008 - 2017 Regenstrief Institute, Inc.
 * %%
 * Licensed 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.
 *
 * #L%
 */
package org.fujion.model;

import org.fujion.component.BaseComponent;

/**
 * This is a composite interface consisting of a list model and its associated renderer.
 *
 * @param  The component type to be rendered.
 * @param  The model type.
 */
public interface IModelAndView {
    
    /**
     * Returns the list model, or null if none set.
     *
     * @return The list model, possibly null.
     */
    IListModel getModel();
    
    /**
     * Sets the list model. If not null and a renderer has been set, the model will be re-rendered
     * immediately. If null, any previous rendering will be removed.
     *
     * @param model The list model, or null to remove an existing one.
     */
    void setModel(IListModel model);
    
    /**
     * Returns the paging controller, if any.
     *
     * @return The paging controller, possibly null.
     */
    IPaginator getPaginator();

    /**
     * Returns the renderer, or null if none set.
     *
     * @return The renderer, possibly null.
     */
    IComponentRenderer getRenderer();
    
    /**
     * Sets the renderer. If not null and a model has been set, the model will be re-rendered
     * immediately. If null, any previous rendering will be removed.
     *
     * @param renderer The renderer, or null to remove an existing one.
     */
    void setRenderer(IComponentRenderer renderer);
    
    /**
     * Force a re-rendering of the model. If either a model or a renderer has not been set, this
     * will have no effect.
     */
    void rerender();
    
    /**
     * Re-render a specific model object.
     *
     * @param object The model object to re-render.
     * @return The rendered model object.
     */
    T rerender(M object);
    
    /**
     * Re-render a specific model object given its index.
     *
     * @param index The index of the model object to re-render.
     * @return The rendered model object.
     */
    T rerender(int index);
    
    /**
     * Returns deferred rendering setting. If true, rendering to the client is deferred until all
     * model objects are rendered, then client updates are sent in bulk. This can be more efficient
     * when rendering a large number of items.
     *
     * @return The deferred rendering setting.
     */
    boolean getDeferredRendering();
    
    /**
     * Sets the deferred rendering setting. If true, rendering to the client is deferred until all
     * model objects are rendered, then client updates are sent in bulk. This can be more efficient
     * when rendering a large number of items.
     *
     * @param value The deferred rendering setting.
     */
    void setDeferredRendering(boolean value);
}