kanzi::connect::ContentQuery Class Reference

A class that represents one ongoing content query that is sent to the content provider. More...

#include <content_query.hpp>

Public Types
typedef vector< ContentQuerySharedPtr >	ContentQueryContainer
	Container for content queries.
typedef function< void(ContentQuery *)	QueryCompleteCallbackFunction)
	Callback function that is invoked when query is completed.

Public Member Functions
void	addQuery (ContentQuerySharedPtr query)
	Add child query to this content query.
ContentQueryContainer::iterator	beginQueries ()
	Iterator to the beginning of the child queries container.
	ContentQuery (const string &uri, QueryCompleteCallbackFunction function)
	Constructor.
ContentQueryContainer::iterator	endQueries ()
	Iterator to the end of the child queries container.
ContentDataSharedPtr	getData ()
	Access to result data for the query.
const string &	getUri () const
	Returns the content URI for this query.
void	notifyCompleted ()
	Notifies the content system that this query has been completed.
void	removeQuery (ContentQuerySharedPtr query)
	Remove child query from this content query.
void	setData (ContentDataSharedPtr data)
	Sets result data for the query.
virtual	~ContentQuery ()
	Destructor.

Detailed Description

A class that represents one ongoing content query that is sent to the content provider.

Member Typedef Documentation

ContentQueryContainer

typedef vector<ContentQuerySharedPtr> kanzi::connect::ContentQuery::ContentQueryContainer

Container for content queries.

QueryCompleteCallbackFunction

typedef function<void(ContentQuery*) kanzi::connect::ContentQuery::QueryCompleteCallbackFunction)

Callback function that is invoked when query is completed.

Constructor & Destructor Documentation

ContentQuery()

kanzi::connect::ContentQuery::ContentQuery	(	const string &	uri,
		QueryCompleteCallbackFunction	function )

Constructor.

Parameters

uri	Content URI for this query.
function	Callback function to invoke when the query is completed.

~ContentQuery()

virtual kanzi::connect::ContentQuery::~ContentQuery ( )

virtual

Destructor.

Member Function Documentation

addQuery()

void kanzi::connect::ContentQuery::addQuery

(

ContentQuerySharedPtr

query

)

Add child query to this content query.

Parameters

query

Query to add.

beginQueries()

ContentQueryContainer::iterator kanzi::connect::ContentQuery::beginQueries

(

)

Iterator to the beginning of the child queries container.

endQueries()

ContentQueryContainer::iterator kanzi::connect::ContentQuery::endQueries

(

)

Iterator to the end of the child queries container.

getData()

ContentDataSharedPtr kanzi::connect::ContentQuery::getData

(

)

Access to result data for the query.

Returns

Content data pointer.

getUri()

const string & kanzi::connect::ContentQuery::getUri

(

)

const

Returns the content URI for this query.

Returns

Content URI for this query.

notifyCompleted()

void kanzi::connect::ContentQuery::notifyCompleted

(

)

Notifies the content system that this query has been completed.

removeQuery()

void kanzi::connect::ContentQuery::removeQuery

(

ContentQuerySharedPtr

query

)

Remove child query from this content query.

Parameters

query

Query to remove.

setData()

void kanzi::connect::ContentQuery::setData

(

ContentDataSharedPtr

data

)

Sets result data for the query.

Parameters

data	New result data.

---

The documentation for this class was generated from the following file:

• content_service/content_query.hpp