Songbird / Development / Songbird Add-Ons API Documentation

sbISQLWhereBuilder Interface Reference

Interface for building WHERE expressions. More...

import "sbISQLBuilder.idl";

Inheritance diagram for sbISQLWhereBuilder:

sbISQLBuilder sbISQLDeleteBuilder sbISQLSelectBuilder sbISQLUpdateBuilder List of all members.

Public Member Functions

void addCriterion (in sbISQLBuilderCriterion aCriterion)
 Add a criteria constraint to the query.
void removeCriterion (in sbISQLBuilderCriterion aCriterion)
 Remve a criteria constraint from the query.
sbISQLBuilderCriterion createMatchCriterionString (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in AString aValue)
 Create a match criterion with an AString datatype.
sbISQLBuilderCriterion createMatchCriterionLong (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in long aValue)
 Create a match criterion with an long datatype.
sbISQLBuilderCriterion createMatchCriterionNull (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType)
 Create a match criterion that tests against the null value.
sbISQLBuilderCriterion createMatchCriterionTable (in AString aLeftTableName, in AString aLeftColumnName, in unsigned long aMatchType, in AString aRightTableName, in AString aRightColumnName)
 Create a match criterion that tests against a table column.
sbISQLBuilderCriterionIn createMatchCriterionIn (in AString aTableName, in AString aSrcColumnName)
 Create a match criterion using the IN() operator.
sbISQLBuilderCriterion createMatchCriterionParameter (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType)
 Create a match criterion that tests against a parameter placeholder.
sbISQLBuilderCriterion createAndCriterion (in sbISQLBuilderCriterion aLeft, in sbISQLBuilderCriterion aRight)
 Create a match criterion that is the logical AND of two critera.
sbISQLBuilderCriterion createOrCriterion (in sbISQLBuilderCriterion aLeft, in sbISQLBuilderCriterion aRight)
 Create a match criterion that is the logical OR of two critera.

Detailed Description

Interface for building WHERE expressions.

Definition at line 184 of file sbISQLBuilder.idl.


Member Function Documentation

void sbISQLWhereBuilder::addCriterion ( in sbISQLBuilderCriterion  aCriterion  ) 

Add a criteria constraint to the query.

Parameters:
aCriterion The Criterion to add

void sbISQLWhereBuilder::removeCriterion ( in sbISQLBuilderCriterion  aCriterion  ) 

Remve a criteria constraint from the query.

Parameters:
aCriterion The Criterion to remove

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionString ( in AString  aTableName,
in AString  aSrcColumnName,
in unsigned long  aMatchType,
in AString  aValue 
)

Create a match criterion with an AString datatype.

Parameters:
aTableName The table name the column in the criterion belongs to
aSrcColumnName The name the column to use in the criterion
aMatchType The criterion match type, must be one of the MATCH constant values
aValue The AString value to match agains

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionLong ( in AString  aTableName,
in AString  aSrcColumnName,
in unsigned long  aMatchType,
in long  aValue 
)

Create a match criterion with an long datatype.

Parameters:
aTableName The table name the column in the criterion belongs to
aSrcColumnName The name the column to use in the criterion
aMatchType The criterion match type, must be one of the MATCH constant values
aValue The long value to match agains

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionNull ( in AString  aTableName,
in AString  aSrcColumnName,
in unsigned long  aMatchType 
)

Create a match criterion that tests against the null value.

Parameters:
aTableName The table name the column in the Criterion belongs to
aSrcColumnName The name the column to use in the criterion
aMatchType The criterion match type, must be either MATCH_EQUALS or MATCH_NOTEQUALS

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionTable ( in AString  aLeftTableName,
in AString  aLeftColumnName,
in unsigned long  aMatchType,
in AString  aRightTableName,
in AString  aRightColumnName 
)

Create a match criterion that tests against a table column.

Parameters:
aLeftTableName The table name on the left side of the match
aLeftColumnName The column name on the right side of the match
aMatchType The criterion match type
aRightTableName The table name on the left side of the match
aRightColumnName The column name on the right side of the match

sbISQLBuilderCriterionIn sbISQLWhereBuilder::createMatchCriterionIn ( in AString  aTableName,
in AString  aSrcColumnName 
)

Create a match criterion using the IN() operator.

Parameters:
aTableName The table name the column in the Criterion belongs to
aSrcColumnName The name the column to use in the criterion

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionParameter ( in AString  aTableName,
in AString  aSrcColumnName,
in unsigned long  aMatchType 
)

Create a match criterion that tests against a parameter placeholder.

Parameters:
aTableName The table name the column in the Criterion belongs to
aSrcColumnName The name the column to use in the criterion
aMatchType The criterion match type

sbISQLBuilderCriterion sbISQLWhereBuilder::createAndCriterion ( in sbISQLBuilderCriterion  aLeft,
in sbISQLBuilderCriterion  aRight 
)

Create a match criterion that is the logical AND of two critera.

Parameters:
aLeft The left side of the expression
aRight The right side of the expression

sbISQLBuilderCriterion sbISQLWhereBuilder::createOrCriterion ( in sbISQLBuilderCriterion  aLeft,
in sbISQLBuilderCriterion  aRight 
)

Create a match criterion that is the logical OR of two critera.

Parameters:
aLeft The left side of the expression
aRight The right side of the expression


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