Encapsulates arguments passed with content queries.
More...
#include <content_query_arguments.hpp>
|
| ContentQueryArguments () |
| C++ constructor. initialize the object. More...
|
|
| ContentQueryArguments (const string &uri, const vector< string > &columns, string filter=string(""), int limitIndex=0, int limitCount=INT_MAX, string sort=string("")) |
| C++ constructor. More...
|
|
| ContentQueryArguments (const string &uri, const vector< string > &columns, const string &filter, const string &limit, const string &sort) |
| C++ constructor. More...
|
|
const vector< string > | getColumns () const |
| Retrieve column names. More...
|
|
const string | getFilter () const |
| Retrieves the filter string. More...
|
|
size_t | getLimitCount () const |
| Retrieves limit count. More...
|
|
size_t | getLimitIndex () const |
| Retrieves limit index. More...
|
|
const string | getLimitString () const |
| Retrieves limit as a string. More...
|
|
const string | getSort () const |
| Retrieves the sort order. More...
|
|
const string | getUri () const |
| Retrieve the URI. More...
|
|
void | setColumns (const vector< string > &columns) |
| Set column names. More...
|
|
void | setFilter (const string &filter) |
| Sets the filter string. More...
|
|
void | setLimit (size_t limitIndex, size_t limitCount=0) |
| Sets the limit. More...
|
|
void | setLimitString (const string &limit) |
| Sets limit as a string. More...
|
|
void | setSort (const string &sort) |
| Sets the sort order. More...
|
|
void | setUri (const string &uri) |
| Set the URI. More...
|
|
QueryArgumentDataSharedPtr | toQueryArgumentData () |
| Converts this internal representation into a format that is transfered over the wire. More...
|
|
virtual | ~ContentQueryArguments () |
| Virtual destructor. More...
|
|
Encapsulates arguments passed with content queries.
◆ ~ContentQueryArguments()
virtual kanzi::connect::ContentQueryArguments::~ContentQueryArguments |
( |
| ) |
|
|
inlinevirtual |
◆ ContentQueryArguments() [1/3]
kanzi::connect::ContentQueryArguments::ContentQueryArguments |
( |
| ) |
|
C++ constructor. initialize the object.
◆ ContentQueryArguments() [2/3]
kanzi::connect::ContentQueryArguments::ContentQueryArguments |
( |
const string & |
uri, |
|
|
const vector< string > & |
columns, |
|
|
string |
filter = string("") , |
|
|
int |
limitIndex = 0 , |
|
|
int |
limitCount = INT_MAX , |
|
|
string |
sort = string("") |
|
) |
| |
C++ constructor.
initialize the object.
- Parameters
-
uri | URI to query |
columns | columns to query |
filter | filter string |
limitIndex | index of the record where to start fetching. Zero based. |
limitCount | maximum amount of elements to fetch. |
sort | sort order (SQL like). |
◆ ContentQueryArguments() [3/3]
kanzi::connect::ContentQueryArguments::ContentQueryArguments |
( |
const string & |
uri, |
|
|
const vector< string > & |
columns, |
|
|
const string & |
filter, |
|
|
const string & |
limit, |
|
|
const string & |
sort |
|
) |
| |
C++ constructor.
initialize the object.
- Parameters
-
uri | URI to query |
columns | colums to query |
filter | filter string |
limit | string to limit results (SQL like). |
sort | sort order (SQL like). |
◆ create()
Factory function to create instance of class with certain set of parameters.
- Parameters
-
uri | content uri |
columns | list of columns to query. |
- Returns
- newly allocated instance.
◆ createFromQueryArgumentData()
Factory function to create instance of the class based on information transfered over the wire.
- Parameters
-
source | the source received from wire |
- Returns
- newly allocated instance.
◆ getColumns()
const vector<string> kanzi::connect::ContentQueryArguments::getColumns |
( |
| ) |
const |
Retrieve column names.
- Returns
- vector of column names.
◆ getFilter()
const string kanzi::connect::ContentQueryArguments::getFilter |
( |
| ) |
const |
Retrieves the filter string.
- Returns
- the filter string.
◆ getLimitCount()
size_t kanzi::connect::ContentQueryArguments::getLimitCount |
( |
| ) |
const |
Retrieves limit count.
- Returns
- limit count. 0 indicates that there is no limit set.
◆ getLimitIndex()
size_t kanzi::connect::ContentQueryArguments::getLimitIndex |
( |
| ) |
const |
Retrieves limit index.
- Returns
- limit index
◆ getLimitString()
const string kanzi::connect::ContentQueryArguments::getLimitString |
( |
| ) |
const |
Retrieves limit as a string.
Empty string is returned if no special limits are defined.
- Returns
- limit as string accepted directly by SQL databases. (empty, count or index,count).
◆ getSort()
const string kanzi::connect::ContentQueryArguments::getSort |
( |
| ) |
const |
Retrieves the sort order.
- Returns
- previously set sort order.
◆ getUri()
const string kanzi::connect::ContentQueryArguments::getUri |
( |
| ) |
const |
Retrieve the URI.
- Returns
- uri
◆ setColumns()
void kanzi::connect::ContentQueryArguments::setColumns |
( |
const vector< string > & |
columns | ) |
|
Set column names.
- Parameters
-
◆ setFilter()
void kanzi::connect::ContentQueryArguments::setFilter |
( |
const string & |
filter | ) |
|
Sets the filter string.
- Parameters
-
◆ setLimit()
void kanzi::connect::ContentQueryArguments::setLimit |
( |
size_t |
limitIndex, |
|
|
size_t |
limitCount = 0 |
|
) |
| |
Sets the limit.
- Parameters
-
limitIndex | start index where to start fetching |
limitCount | maximum amount of elements to fetch. |
◆ setLimitString()
void kanzi::connect::ContentQueryArguments::setLimitString |
( |
const string & |
limit | ) |
|
Sets limit as a string.
- Parameters
-
limit | the string representing the limit. INDEX,COUNT or just INDEX |
◆ setSort()
void kanzi::connect::ContentQueryArguments::setSort |
( |
const string & |
sort | ) |
|
Sets the sort order.
- Parameters
-
sort | sort string line in SQL (ASC, DESC). |
◆ setUri()
void kanzi::connect::ContentQueryArguments::setUri |
( |
const string & |
uri | ) |
|
◆ toQueryArgumentData()
Converts this internal representation into a format that is transfered over the wire.
- Returns
- QueryArgumentData instance that can be sent to wire.
The documentation for this class was generated from the following file:
- content_service/content_query_arguments.hpp