org.synchronoss.cpo
Interface CpoOrderBy

All Known Implementing Classes:

JdbcCpoOrderBy

public interface CpoOrderBy

CpoOrderBy is an interface for specifying the sort order in which objects are returned from the Datasource.

Method Summary

boolean	getAscending() Gets the boolean that determines if the objects will be returned from from the CpoAdapter in Ascending order or Descending order
java.lang.String	getAttribute() Gets the name of the attribute that is to be used to sort the results from the CpoAdapter.
java.lang.String	getFunction() Gets a string representing a datasource specific function call that must be applied to the attribute that will be used for sorting.
void	setAscending(boolean b) Sets the boolean that determines if the objects will be returned from from the CpoAdapter in Ascending order or Descending order
void	setAttribute(java.lang.String s) Sets the name of the attribute that is to be used to sort the results from the CpoAdapter.
void	setFunction(java.lang.String s) Sets a string representing a datasource specific function call that must be applied to the attribute that will be used for sorting.

Method Detail

getAscending

boolean getAscending()

Gets the boolean that determines if the objects will be returned from from the CpoAdapter in Ascending order or Descending order

Returns:

boolean true if it is to sort in Ascensing Order false if it is to be sorted in Descending Order

setAscending

void setAscending(boolean b)

Sets the boolean that determines if the objects will be returned from from the CpoAdapter in Ascending order or Descending order

Parameters:

b - true if it is to sort in Ascensing Order false if it is to be sorted in Descending Order

getAttribute

java.lang.String getAttribute()

Gets the name of the attribute that is to be used to sort the results from the CpoAdapter.

Returns:

String The name of the attribute

setAttribute

void setAttribute(java.lang.String s)

Sets the name of the attribute that is to be used to sort the results from the CpoAdapter.

Parameters:

s - The name of the attribute

getFunction

java.lang.String getFunction()

Gets a string representing a datasource specific function call that must be applied to the attribute that will be used for sorting. i.e. - "upper(attribute_name)"

Returns:

String The name of the function

setFunction

void setFunction(java.lang.String s)

Sets a string representing a datasource specific function call that must be applied to the attribute that will be used for sorting. i.e. - "upper(attribute_name)"

Parameters:

s - The name of the function