001/*
002 * (C) Copyright 2006 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id: SortableDataModel.java 11041 2007-01-31 15:43:30Z atchertchian $
020 */
021
022package org.nuxeo.ecm.platform.ui.web.model;
023
024import java.io.Serializable;
025
026/**
027 * Provides support for sorting table models. Inspired from Tomahawk examples. Abstract method design pattern.
028 *
029 * @author <a href="mailto:rcaraghin@nuxeo.com">Razvan Caraghin</a>
030 */
031public interface SortableDataModel extends Serializable {
032
033    /**
034     * Sort the list. Should be implemented by the children to customize the sort (what comparators should be used, what
035     * other condition must be met).
036     */
037    void sort(String column, boolean ascending);
038
039    /**
040     * Is the default sort direction for the given column "ascending" ?
041     */
042    boolean isDefaultAscending(String sortColumn);
043
044    void sort(String sortColumn);
045
046    String getSort();
047
048    void setSort(String sort);
049
050    boolean isAscending();
051
052    void setAscending(boolean ascending);
053
054}