wt.query
Class OrderBy

java.lang.Object
  wt.query.OrderBy

All Implemented Interfaces:

Serializable

public class OrderBy
extends Object
implements Serializable

This class represents an OrderBy clause.

Supported API: true

Extendable: false

See Also:

Serialized Form

Constructor Summary

OrderBy(OrderByExpression a_expression, boolean a_descending)


Supported API: true

OrderBy(OrderByExpression a_expression, boolean a_descending, Locale a_locale)


Supported API: true

Method Summary

Locale	getLocale() Gets the value of the attribute: locale; Locale to use for database sorting.
boolean	isDescending() Gets the value of the attribute: descending; Indicates if the sort is descending (true) or ascending (false).
void	setDescending(boolean a_Descending) Sets the value of the attribute: descending; Indicates if the sort is descending (true) or ascending (false).
void	setLocale(Locale a_Locale) Sets the value of the attribute: locale; Locale to use for database sorting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderBy

public OrderBy(OrderByExpression a_expression,
               boolean a_descending)
        throws QueryException

Supported API: true

Parameters:

a_expression -

a_descending -

Throws:

QueryException

OrderBy

public OrderBy(OrderByExpression a_expression,
               boolean a_descending,
               Locale a_locale)
        throws QueryException

Supported API: true

Parameters:

a_expression -

a_descending -

a_locale -

Throws:

QueryException

Method Detail

isDescending

public boolean isDescending()

Gets the value of the attribute: descending; Indicates if the sort is descending (true) or ascending (false).

Supported API: true

Returns:

boolean

setDescending

public void setDescending(boolean a_Descending)
                   throws WTPropertyVetoException

Sets the value of the attribute: descending; Indicates if the sort is descending (true) or ascending (false).

Supported API: true

Parameters:

a_Descending -

Throws:

WTPropertyVetoException

getLocale

public Locale getLocale()

Gets the value of the attribute: locale; Locale to use for database sorting.

Supported API: true

Returns:

Locale

setLocale

public void setLocale(Locale a_Locale)
               throws WTPropertyVetoException

Sets the value of the attribute: locale; Locale to use for database sorting.

Supported API: true

Parameters:

a_Locale -

Throws:

WTPropertyVetoException