Collaboration API Documentation

com.filenet.bso.api.collaboration.query
Interface OrderBy

All Superinterfaces:
java.io.Serializable

public interface OrderBy
extends java.io.Serializable

Interface to specify a single property based order option. One or more of these can be specified to control how the query results are ordered.


Field Summary
static int ASCENDING
          Option to specify results are in ascending order.
static int DESCENDING
          Option to specify results are in descending order.
 
Method Summary
 int getDirection()
          Returns the direction specified with setDirection().
 java.lang.String getPropertySymName()
          Returns the property specified with setPropertySymname().
 void setDirection(int direction)
          Specifies the direction as ASCENDING or DESCENDING.
 void setPropertySymName(java.lang.String symname)
          Specify the property to order the results by.
 

Field Detail

ASCENDING

public static final int ASCENDING
Option to specify results are in ascending order.

DESCENDING

public static final int DESCENDING
Option to specify results are in descending order.
Method Detail

setPropertySymName

public void setPropertySymName(java.lang.String symname)
Specify the property to order the results by.

getPropertySymName

public java.lang.String getPropertySymName()
Returns the property specified with setPropertySymname().

setDirection

public void setDirection(int direction)
Specifies the direction as ASCENDING or DESCENDING.

getDirection

public int getDirection()
Returns the direction specified with setDirection().

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.