// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.orsup.selection;

/**
 * An abstract representation of a SQL <i>ORDER BY DESCENDING</i> clause.<p>
 * <a href="../../Licence.txt">Licence</a><br>
 * <p/>
 * Two methods are provided to translate an <b>OrderBy</b> (with optional
 * sub-orderby(s)) into <b>String</b>s:<p>
 * <pre>
 *      toString() ;
 *      toSQL() ;
 * </pre>
 * <p/>
 * The <i>toString()</i> is intended for debuging purposes.<p>
 * <p/>
 * Exceptions: All problems caught when the parameter(s) are checked (as
 * indicated/implied in the @param tags) will generate an IllegalArgumentException,
 * and means the API user has a problem.  If a NullPointerException (or some
 * others, like: ClassCastException or ArrayIndexOutOfBoundsException) is thrown,
 * it means the API developer has a problem.  Any Exception that is explicitly
 * thrown in the API, but unrelated to a parameter, will be listed in the throws
 * clause (and hopefully in the tag @throws).  These may (but probably won't) be
 * checked Exceptions.
 *
 * @author George Smith
 * @version 1.0 06/20/02
 */

public class OrderByDescending extends OrderBy
{
    /**
     * Constructor that supports a Column Definition.<p>
     *
     * @param pColumnDefinition Column Definition (!null).
     */
    public OrderByDescending( SimpleColumnDefinition pColumnDefinition )
    {
        super( pColumnDefinition );
    }

    /**
     * Constructor that supports a Column Definition.<p>
     *
     * @param pColumnDefinition Column Definition (!null).
     * @param pSubOrderBy       Sub OrderBy (!null).
     */
    public OrderByDescending( SimpleColumnDefinition pColumnDefinition, OrderBy pSubOrderBy )
    {
        super( pColumnDefinition, pSubOrderBy );
    }

    /**
     * Accessor to determine if the Order by is Descending.<p>
     *
     * @return True if is Descending.
     */
    @Override
    public boolean isDescending()
    {
        return true;
    }
}