Songbird / Development / Songbird Add-Ons API Documentation

sbISQLSelectBuilder Interface Reference

Interface for building SELECT statements. More...

import "sbISQLBuilder.idl";

Inheritance diagram for sbISQLSelectBuilder:

sbISQLWhereBuilder sbISQLBuilder List of all members.

Public Member Functions

void addColumn (in AString aTableName, in AString aColumnName)
 Add a column to the output column list.
void clearColumns ()
 Clears added columns.
void addOrder (in AString aTableName, in AString aColumnName, in boolean aAscending)
 Add an order clause to the query.
void addRandomOrder ()
 Add a random order clause to the query.
void addGroupBy (in AString aTableName, in AString aColumnName)
 Add an group by clause to the query.

Public Attributes

attribute AString baseTableName
 The query's base table.
attribute AString baseTableAlias
 The query's base table's alias.
attribute boolean distinct
 Is the query distinct?

Detailed Description

Interface for building SELECT statements.

Definition at line 300 of file sbISQLBuilder.idl.


Member Function Documentation

void sbISQLSelectBuilder::addColumn ( in AString  aTableName,
in AString  aColumnName 
)

Add a column to the output column list.

Parameters:
aTableName The table name the column belongs to. To omit the table name qualification, use null.
aColumnName The name of the column to add to the list

void sbISQLSelectBuilder::addOrder ( in AString  aTableName,
in AString  aColumnName,
in boolean  aAscending 
)

Add an order clause to the query.

Parameters:
aTableName Table name the column belongs to
aColumnName Name of the column to sort
aAscending True if the sort should be ascending

void sbISQLSelectBuilder::addRandomOrder (  ) 

Add a random order clause to the query.

Parameters:
aTableName Table name the column belongs to

void sbISQLSelectBuilder::addGroupBy ( in AString  aTableName,
in AString  aColumnName 
)

Add an group by clause to the query.

Parameters:
aTableName Table name the column belongs to
aColumnName Name of the column to group on


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:02 2009 for Songbird by  doxygen 1.5.2