001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software GmbH & Co. KG, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.workplace.list; 029 030import java.util.Comparator; 031import java.util.Locale; 032 033/** 034 * A list item comparator can be set at a column definition to set the sorting method for that column.<p> 035 * 036 * @since 6.0.0 037 */ 038public interface I_CmsListItemComparator { 039 040 /** 041 * Returns a new comparator for comparing list items by the given column, 042 * and using the given locale.<p> 043 * 044 * @param columnId the id of the column to sort by 045 * @param locale the current used locale 046 * 047 * @return a new comparator 048 */ 049 Comparator<CmsListItem> getComparator(final String columnId, final Locale locale); 050}