001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2015 ForgeRock AS
026 */
027
028package org.opends.quicksetup.ui;
029
030import javax.swing.table.TableModel;
031
032/**
033 * A generic interface that must implement table models that are sortable.
034 */
035public interface SortableTableModel extends TableModel
036{
037  /**
038   * Returns whether the sort is ascending or descending.
039   * @return <CODE>true</CODE> if the sort is ascending and <CODE>false</CODE>
040   * otherwise.
041   */
042  boolean isSortAscending();
043
044  /**
045   * Sets whether to sort ascending of descending.
046   * @param sortAscending whether to sort ascending or descending.
047   */
048  void setSortAscending(boolean sortAscending);
049
050  /**
051   * Returns the column index used to sort.
052   * @return the column index used to sort.
053   */
054  int getSortColumn();
055
056  /**
057   * Sets the column index used to sort.
058   * @param sortColumn column index used to sort..
059   */
060  void setSortColumn(int sortColumn);
061
062  /**
063   * Updates the table model contents and sorts its contents depending on the
064   * sort options set by the user.
065   */
066  void forceResort();
067}