SDK  2.1.4 [async]
CloudBackend Software Development Kit - SDK API for C++
cbe::QueryChainExt Class Reference

Extension of class QueryChain. More...

#include <QueryChain.h>

Inheritance diagram for cbe::QueryChainExt:
Collaboration diagram for cbe::QueryChainExt:

Public Member Functions

QueryChainExt join (Container containerToQuery, std::string key1, std::string key2)
 
QueryChainExt join (Container containerToQuery, std::string key1, std::string key2, Filter constraints)
 
QueryChainExt join (Container containerToQuery, std::string key1, std::string key2, Container containerForResults)
 
QueryChainExt join (Container containerToQuery, std::string key1, std::string key2, Filter constraints, Container containerForResults)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, JoinDelegatePtr joinDelegate)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, Filter constraints, JoinDelegatePtr joinDelegate)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, Container containerForResults, JoinDelegatePtr joinDelegate)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, Filter constraints, Container containerForResults, JoinDelegatePtr joinDelegate)
 
- Public Member Functions inherited from cbe::QueryChain
QueryChain join (Container containerToQuery, std::string key1, std::string key2, JoinDelegatePtr joinDelegate)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, Filter constraints, JoinDelegatePtr joinDelegate)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, Container containerForResults, JoinDelegatePtr joinDelegate)
 
QueryChain join (Container containerToQuery, std::string key1, std::string key2, Filter constraints, Container containerForResults, JoinDelegatePtr joinDelegate)
 
QueryResult getQueryResult () const
 
 QueryChain (cbe::DefaultCtor)
 
 operator bool () const
 

Friends

class CloudBackend
 
class Container
 

Additional Inherited Members

- Public Types inherited from cbe::QueryChain
using JoinDelegatePtr = delegate::JoinDelegatePtr
 

Detailed Description

Extension of class QueryChain.

[Async] QueryChainExt is used when the query is carried out with subsequent intended join in mind.
I.e., we have passed a QueryJoinDelegate to the previous call and that will then be reused in the trailing join()-call. It is an extension of class QueryChain offering join() methods that do not require a new delegate.
Instead, these will use the delegate passed as argument in the previous invocation in the call chain — i.e.:

Member Function Documentation

◆ join() [1/8]

QueryChainExt cbe::QueryChainExt::join ( Container  containerToQuery,
std::string  key1,
std::string  key2 
)

Performs a join request in line with function join() in class QueryChain.
If a call to this join function is chained with a previous call to a query, only such a query functions accepting a QueryJoinDelegate can be used as:

Asynchronous version of this service function.

See also
QueryChain::join(Container,std::string,std::string,delegate::JoinDelegatePtr)

◆ join() [2/8]

QueryChainExt cbe::QueryChainExt::join ( Container  containerToQuery,
std::string  key1,
std::string  key2,
Container  containerForResults 
)

◆ join() [3/8]

QueryChain cbe::QueryChain::join

Same as join(Container,std::string,std::string,delegate::JoinDelegatePtr), but with an additional Container parameter containerForResults .

Parameters
containerForResultsCan be the Container from the previous query if desired items should be from that container.

◆ join() [4/8]

QueryChainExt cbe::QueryChainExt::join ( Container  containerToQuery,
std::string  key1,
std::string  key2,
Filter  constraints 
)

◆ join() [5/8]

QueryChainExt cbe::QueryChainExt::join ( Container  containerToQuery,
std::string  key1,
std::string  key2,
Filter  constraints,
Container  containerForResults 
)

◆ join() [6/8]

QueryChain cbe::QueryChain::join

Same as join(Container,std::string,std::string,Container,delegate::JoinDelegatePtr), but with an additional Filter parameter constraints .

Parameters
constraintsA filter that provides any constraints for the query.

◆ join() [7/8]

QueryChain cbe::QueryChain::join

Same as join(Container,std::string,std::string,delegate::JoinDelegatePtr), but with an additional Filter parameter constraints .

Parameters
constraintsA filter that provides any constraints for the query.

◆ join() [8/8]

QueryChain cbe::QueryChain::join

Performs a join request in conjunction with a query, or previous join, to get related items from another container.

Asynchronous version of this service function.

Parameters
containerToQueryThe container of which the join shall be done with.
key1The key from the previous query on which to perform the join.
key2The key on objects in containerToQuery on which to perform the join
joinDelegatePointer to a JoinDelegate instance, implemented by the user, that receives the response of this query request.
I.e., either of the JoinDelegate callback functions onJoinSuccess() or onJoinError() will be called.

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