com.crystaldecisions.sdk.occa.report.data
Class SortDirection

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.SortDirection

public final class SortDirection
extends java.lang.Object

This class contains constants that define how fields are sorted.


Field Summary
static int _ascendingOrder
           Ascending order.
static int _bottomNOrder
          Only the bottom N are sorted.
static int _bottomNPercentage
          Only the bottom N percentages are sorted.
static int _descendingOrder
           Descending order.
static int _noSort
          Indicates a Group sorted in original order or specified order, with no top-N sorting.
static int _topNOrder
          Only the top N are sorted.
static int _topNPercentage
          Only the top N percentages are sorted.
static SortDirection ascendingOrder
           A SortDirection object that specifies ascending order.
static SortDirection bottomNOrder
          A SortDirection object that specifies only the bottom N are sorted.
static SortDirection bottomNPercentage
          A SortDirection object that specifies only the bottom N percentages are sorted.
static SortDirection descendingOrder
           A SortDirection object that specifies descending order.
static SortDirection noSort
          A SortDirection object that specifies a Group that is sorted in original order or specified order, and does not have top-N sorting.
static SortDirection topNOrder
          A SortDirection object that specifies only the top N are sorted.
static SortDirection topNPercentage
          A SortDirection object that specifies only the top N percentages are sorted.
 
Method Summary
static SortDirection from_int(int i)
           Returns the SortDirection object corresponding to the specified value.
static SortDirection from_string(java.lang.String sVal)
           Returns the SortDirection object corresponding to the specified type.
 java.lang.String toString()
           Returns the String value of this SortDirection object.
 int value()
           Returns the int value of this SortDirection object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_noSort

public static final int _noSort

Indicates a Group sorted in original order or specified order, with no top-N sorting.

This is not a valid sort direction for record sorts.

Modification of sorts whose sort direction is noSort is not supported.

See Also:
Constant Field Values

_ascendingOrder

public static final int _ascendingOrder

Ascending order.

See Also:
Constant Field Values

_descendingOrder

public static final int _descendingOrder

Descending order.

See Also:
Constant Field Values

_topNOrder

public static final int _topNOrder

Only the top N are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.

See Also:
Constant Field Values

_bottomNOrder

public static final int _bottomNOrder

Only the bottom N are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.

See Also:
Constant Field Values

_topNPercentage

public static final int _topNPercentage

Only the top N percentages are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.

See Also:
Constant Field Values

_bottomNPercentage

public static final int _bottomNPercentage

Only the bottom N percentages are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.

See Also:
Constant Field Values

noSort

public static final SortDirection noSort

A SortDirection object that specifies a Group that is sorted in original order or specified order, and does not have top-N sorting.

This is not a valid sort direction for record sorts.

Modification of sorts whose sort direction is noSort is not supported.


ascendingOrder

public static final SortDirection ascendingOrder

A SortDirection object that specifies ascending order.


descendingOrder

public static final SortDirection descendingOrder

A SortDirection object that specifies descending order.


topNOrder

public static final SortDirection topNOrder

A SortDirection object that specifies only the top N are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.


bottomNOrder

public static final SortDirection bottomNOrder

A SortDirection object that specifies only the bottom N are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.


topNPercentage

public static final SortDirection topNPercentage

A SortDirection object that specifies only the top N percentages are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.


bottomNPercentage

public static final SortDirection bottomNPercentage

A SortDirection object that specifies only the bottom N percentages are sorted.

Only valid for Group sorts. This is not a valid sort direction for record sorts.

Method Detail

from_int

public static final SortDirection from_int(int i)

Returns the SortDirection object corresponding to the specified value.

Parameters:
i - The int value of the desired SortDirection object.
Returns:
The SortDirection object corresponding to the specified value.

from_string

public static final SortDirection from_string(java.lang.String sVal)

Returns the SortDirection object corresponding to the specified type.

Parameters:
sVal - A String containing type of the desired SortDirection object.
Returns:
The SortDirection object corresponding to the specified type.

toString

public java.lang.String toString()

Returns the String value of this SortDirection object.

Overrides:
toString in class java.lang.Object
Returns:
The String value of this SortDirection object.

value

public int value()

Returns the int value of this SortDirection object.

Returns:
The int value of this SortDirection object.