Package com.ptc.core.meta.common

Interface SortSpec

All Superinterfaces:

AttributeTypeIdentifierList

public interface SortSpec
extends AttributeTypeIdentifierList

This interface provides the abstraction for specifying sorting. The sorting is specified in terms of a list of AttributeTypeIdentifiers and an associated ascending and case sensitive boolean attributes. The order of the list is significant (e.g. the AttributeTypeIdentifier at index 0 is the primary sort attribute).

Supported API: true

Extendable: false

Field Summary

Fields inherited from interface com.ptc.core.meta.common.AttributeTypeIdentifierList

SIZE

Method Summary

Modifier and Type	Method	Description
Object	getPrimitive(int a_index)	Returns a primitive object for specifying a sort expression.
boolean	isAscending(int a_index)	Indicates if the AttributeTypeIdentifier value at the specified index should be sorted in ascending order.
boolean	isCaseSensitive(int a_index)	Indicates if the AttributeTypeIdentifier value at the specified index should be sorted case sensitive.

Methods inherited from interface com.ptc.core.meta.common.AttributeTypeIdentifierList

getAttributeTypeIdentifier, getIndex, getSize, toAttributeTypeIdentifierArray

Method Details

isAscending

boolean isAscending(int a_index)

Indicates if the AttributeTypeIdentifier value at the specified index should be sorted in ascending order.

Supported API: true

Parameters:

a_index -

Returns:

boolean

isCaseSensitive

boolean isCaseSensitive(int a_index)

Indicates if the AttributeTypeIdentifier value at the specified index should be sorted case sensitive.

Supported API: true

Parameters:

a_index -

Returns:

boolean

getPrimitive

Object getPrimitive(int a_index)
             throws WTException

Returns a primitive object for specifying a sort expression.

Supported API: true

Parameters:

a_index -

Returns:

Object

Throws:

WTException