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