001    // Copyright 2007, 2008 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.grid;
016    
017    import org.apache.tapestry5.beaneditor.BeanModel;
018    
019    /**
020     * A provider of model data to the sub-components of the {@link org.apache.tapestry5.corelib.components.Grid} component.
021     * The primary implementor of this component is the Grid component itself. This is effectively a way to package three
022     * values as a single parameter to components such as {@link org.apache.tapestry5.corelib.components.GridColumns} and
023     * {@link org.apache.tapestry5.corelib.components.GridRows}.
024     */
025    public interface GridModel
026    {
027        /**
028         * Returns the data model, which defines the columns (in terms of properties of the row type), and provides access
029         * to actual values for a given row instance.
030         */
031        BeanModel getDataModel();
032    
033        /**
034         * Returns the source for the data to be presented in the Grid.
035         */
036        GridDataSource getDataSource();
037    
038        /**
039         * Returns the object used to track sorting behavior of the Grid.
040         */
041        GridSortModel getSortModel();
042    }