SICITotal Protocol Reference
| Conforms to | NSObject |
|---|---|
| Declared in | SICITotal.h |
Overview
Exposes API’s to return total of all non-NULL values in the group. The non-standard total() function is provided as a convenient way to work around this design problem in the SQL language. The result of total() is always a floating point value.
– where:
required method
Column name of which condition will be specified.
- (id<SICITotalClause>)where:(NSString *)columnParameters
column |
Name of column. |
|---|
Return Value
SICITotalClause Interface.
Discussion
Column name of which condition will be specified.
Declared In
SICITotal.h
– whereClause:
required method
Used to provide manually created Where clause, instead of using API’s.
- (id<SICITotal>)whereClause:(NSString *)whereClauseParameters
whereClause |
Manually created where clause. |
|---|
Return Value
SICITotal Interface.
Discussion
Used to provide manually created Where clause, instead of using API’s.
Declared In
SICITotal.h
– and:
required method
Used to specify AND condition between where clause.
- (id<SICITotalClause>)and:(NSString *)columnParameters
column |
Name of column on which condition need to be specified. |
|---|
Return Value
SICITotalClause Interface.
Discussion
Used to specify AND condition between where clause.
Declared In
SICITotal.h
– or:
required method
Used to specify OR condition between where clause.
- (id<SICITotalClause>)or:(NSString *)columnParameters
column |
Name of column on which condition need to be specified. |
|---|
Return Value
SICITotalClause Interface.
Discussion
Used to specify OR condition between where clause.
Declared In
SICITotal.h
– groupBy:
required method
Used to specify GROUP BY statement in conjunction with the aggregate functions to group the result-set by one or more columns.
- (id<SICITotal>)groupBy:(NSArray *)columnsParameters
columns |
Name of columns. |
|---|
Return Value
SICITotal Interface.
Discussion
Used to specify GROUP BY statement in conjunction with the aggregate functions to group the result-set by one or more columns.
Declared In
SICITotal.h
– having:
required method
Used to specify HAVING clause to SQL because the WHERE keyword could not be used with aggregate functions.
- (id<SICITotalClause>)having:(NSString *)columnParameters
column |
Name of column on which condition need to be applied. |
|---|
Return Value
SICITotalClause Interface.
Discussion
Used to specify HAVING clause to SQL because the WHERE keyword could not be used with aggregate functions.
Declared In
SICITotal.h
– havingClause:
required method
Used to provide manually created Where clause, instead of using API’s.
- (id<SICITotal>)havingClause:(NSString *)havingClauseParameters
havingClause |
Where clause. |
|---|
Return Value
SICITotal Interface.
Discussion
Used to provide manually created Where clause, instead of using API’s.
Declared In
SICITotal.h
– column:
required method
Used to provide name of column for which total will be calculated.
- (id<SICITotal>)column:(NSString *)columnParameters
column |
Name of column. |
|---|
Return Value
SICITotal Interface.
Discussion
Used to provide name of column for which total will be calculated.
Declared In
SICITotal.h
– execute
required method
Used to get total, this method should be called in last to calculate total.
- (id)executeReturn Value
Return total.
Discussion
Used to get total, this method should be called in last to calculate total.
Exceptions
SICDatabaseException |
Throws exception if any error occur while calculating total. |
|---|
Declared In
SICITotal.h