oracle.ifs.common
Class SortQualifier

java.lang.Object
  |
  +--oracle.ifs.common.SortQualifier

All Implemented Interfaces:

java.io.Serializable

public final class SortQualifier

extends java.lang.Object

implements java.io.Serializable

A SortQualifer encapsulates the specification of the sort of a single attribute.

One or more SortQualifiers is associated with a SortSpecification, to enable the creation of a SQL order by clause associated with various queries used in iFS.

See Also:

Serialized Form

Constructor Summary

SortQualifier(java.lang.String sortAttribute, boolean sortOrder)
Construct a SortQualifier for a simple qualifier of Attribute and sort direction.

SortQualifier(java.lang.String sortAttribute, boolean sortOrder, java.lang.String sortClass, java.lang.String sortAlias, java.lang.String sqlFunction)
Construct a SortQualifier for complex qualifiers.

Method Summary

java.lang.String	getAttributeName() Get the Attribute name.
java.lang.String	getClassAlias() Get the alias for the sort attribute's class
java.lang.String	getClassName() Get the sort attribute's class name
boolean	getSortOrder() Get the sort order.
protected java.lang.String	getSqlFunction() Get the SQL function to apply on this qualifier.

Constructor Detail

SortQualifier

public SortQualifier(java.lang.String sortAttribute,
                     boolean sortOrder)
              throws IfsException

Construct a SortQualifier for a simple qualifier of Attribute and sort direction. The Attribute's ClassObject is assumed to be the default set on the parent SortSpecification. No class alias is used, nor is any SQL function applied to the qualifier.

Parameters:

sortAttribute - the sort attribute name

sortOrder - the corresponding sort order

Throws:

IfsException - if operation fails.

SortQualifier

public SortQualifier(java.lang.String sortAttribute,
                     boolean sortOrder,
                     java.lang.String sortClass,
                     java.lang.String sortAlias,
                     java.lang.String sqlFunction)
              throws IfsException

Construct a SortQualifier for complex qualifiers.

Parameters:

sortAttribute - the sort attribute name

sortOrder - the corresponding sort order

sortClass - the sort attribute's class name

sortAlias - an alias for the sort attribute's class

sqlFunction - SQL function to apply to the qualifier, or null for no function

Throws:

IfsException - if operation fails.

Method Detail

getAttributeName

public java.lang.String getAttributeName()
                                  throws IfsException

Get the Attribute name.

Returns:

the sort attribute name

Throws:

IfsException - if operation fails.

getSortOrder

public boolean getSortOrder()
                     throws IfsException

Get the sort order.

Returns:

the sort order

Throws:

IfsException - if operation fails.

getClassName

public java.lang.String getClassName()
                              throws IfsException

Get the sort attribute's class name

Returns:

the sort attribute's class name

Throws:

IfsException - if operation fails.

getClassAlias

public java.lang.String getClassAlias()
                               throws IfsException

Get the alias for the sort attribute's class

Returns:

alias for the sort attribute's class

Throws:

IfsException - if operation fails.

getSqlFunction

protected java.lang.String getSqlFunction()
                                   throws IfsException

Get the SQL function to apply on this qualifier.

Returns:

the SQL function, or null is no function is to be applied

Throws:

IfsException - if operation fails.