com.crystaldecisions.sdk.occa.report.data
Interface ISort

All Superinterfaces:
IClone
All Known Subinterfaces:
ITopNSort
All Known Implementing Classes:
Sort, TopNSort

public interface ISort
extends IClone

This interface is used to get and set how data is sorted. It indicates which data is being sorted and the direction in which this data is sorted.


Method Summary
 void addInteractiveControlObjectName(java.lang.String iControlObjName)
          For internal use only
 SortDirection getDirection()
           Returns the direction in which the data is sorted.
 int getInteractiveControlObjectIndex(java.lang.String objectName)
          For internal use only
 java.util.List getInteractiveControlObjectNames()
          For internal use only
 IField getSortField()
           Returns the field that is being sorted.
 boolean isInteractive()
          For internal use only
 void setDirection(SortDirection direction)
           Sets the direction in which the data is sorted.
 void setInteractiveControlObjectNames(java.util.List iControlObjNames)
          For internal use only
 void setSortField(IField sortField)
           Sets the field that is being sorted.
 

Method Detail

getDirection

SortDirection getDirection()

Returns the direction in which the data is sorted.

Returns:
A SortDirection object that specifies the direction in which that data is sorted.

getSortField

IField getSortField()

Returns the field that is being sorted.

Returns:
An IField object containing the field that is being sorted.

getInteractiveControlObjectNames

java.util.List getInteractiveControlObjectNames()
For internal use only


isInteractive

boolean isInteractive()
For internal use only


getInteractiveControlObjectIndex

int getInteractiveControlObjectIndex(java.lang.String objectName)
For internal use only


setDirection

void setDirection(SortDirection direction)

Sets the direction in which the data is sorted.

Parameters:
direction - A SortDirection object that specifies the direction in which that data is sorted.

setSortField

void setSortField(IField sortField)

Sets the field that is being sorted.

Parameters:
sortField - An IField object containing the field that is being sorted.

addInteractiveControlObjectName

void addInteractiveControlObjectName(java.lang.String iControlObjName)
For internal use only


setInteractiveControlObjectNames

void setInteractiveControlObjectNames(java.util.List iControlObjNames)
For internal use only