oracle.ifs.common
Class SortSpecification

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class SortSpecification

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

The SortSpecification class is used to specify a sort order for operations that can be sorted, such as opening a folder. This is typically a set of attribute names and a boolean that represents either ascending or descending.

See Also:

Serialized Form

Constructor Summary

SortSpecification()
default constructor.

Method Summary

void	addSortQualifier(SortQualifier sortqual) Add a SortQualifier.
void	addSortQualifier(java.lang.String sortAttribute, boolean sortOrder) Add a simple SortQualifier.
java.lang.String	getDefaultAlias() return the Default alias setting.
java.lang.String	getDefaultClass() return the Default Class setting.
SortQualifier[]	getSortQualifiers() Returns the current set of SortQualifers as an array.
void	setDefaultAlias(java.lang.String defAlias) set the Default Alias.
void	setDefaultClass(java.lang.String defClass) set the Default Class.

Constructor Detail

SortSpecification

public SortSpecification()
                  throws IfsException

default constructor.

Throws:

IfsException - if operation fails.

Method Detail

addSortQualifier

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

Add a simple SortQualifier.

Parameters:

sortAttribute - the sort attribute name

sortOrder - the corresponding sort order

Throws:

IfsException - if operation fails.

addSortQualifier

public void addSortQualifier(SortQualifier sortqual)
                      throws IfsException

Add a SortQualifier.

Parameters:

sortqual - the sort qualifier

Throws:

IfsException - if operation fails.

setDefaultClass

public void setDefaultClass(java.lang.String defClass)
                     throws IfsException

set the Default Class.

Parameters:

defClass - the Default Class name.

Throws:

IfsException - if operation fails.

getDefaultClass

public java.lang.String getDefaultClass()
                                 throws IfsException

return the Default Class setting.

Returns:

the Default Class setting.

Throws:

IfsException - if operation fails.

setDefaultAlias

public void setDefaultAlias(java.lang.String defAlias)
                     throws IfsException

set the Default Alias.

Parameters:

defAlias - the alias.

Throws:

IfsException - if operation fails.

getDefaultAlias

public java.lang.String getDefaultAlias()
                                 throws IfsException

return the Default alias setting.

Returns:

the Default alias setting.

Throws:

IfsException - if operation fails.

getSortQualifiers

public SortQualifier[] getSortQualifiers()
                                  throws IfsException

Returns the current set of SortQualifers as an array.

Returns:

the SortQualifers set on this instance

Throws:

IfsException - if operation fails.