ledger::core::api::OperationQuery Class Reference

#include <OperationQuery.hpp>

Inheritance diagram for ledger::core::api::OperationQuery:

Public Member Functions
virtual std::shared_ptr< OperationQuery >	addOrder (OperationOrderKey key, bool descending)=0
virtual std::shared_ptr< QueryFilter >	filter ()=0
virtual std::shared_ptr< OperationQuery >	offset (int64_t from)=0
virtual std::shared_ptr< OperationQuery >	limit (int64_t count)=0
virtual std::shared_ptr< OperationQuery >	complete ()=0
virtual std::shared_ptr< OperationQuery >	partial ()=0
virtual void	execute (const std::shared_ptr< OperationListCallback > &callback)=0

Detailed Description

Class respresenting a query for a set of operations.

Member Function Documentation

addOrder()

virtual std::shared_ptr<OperationQuery> ledger::core::api::OperationQuery::addOrder ( OperationOrderKey  key, bool  descending  )

pure virtual

Apply given order to query's operation.

Parameters

key,OperationOrderKey	object which defines order
descending,bool

Returns

OperationQuery object, new ordered operation

Implemented in ledger::core::OperationQuery.

complete()

virtual std::shared_ptr<OperationQuery> ledger::core::api::OperationQuery::complete ( )

pure virtual

TODO Complete the operation query.

Implemented in ledger::core::OperationQuery.

execute()

virtual void ledger::core::api::OperationQuery::execute ( const std::shared_ptr< OperationListCallback > &  callback )

pure virtual

Execute query to retrieve operations.

Parameters

callback,if

execute method succeed, ListCallback object returning a List of Operation objects

filter()

virtual std::shared_ptr<QueryFilter> ledger::core::api::OperationQuery::filter ( )

pure virtual

Get applied filter on operation query.

Returns

QueryFilter object

Implemented in ledger::core::OperationQuery.

limit()

virtual std::shared_ptr<OperationQuery> ledger::core::api::OperationQuery::limit ( int64_t  count )

pure virtual

Add limit to the operation query results.

Parameters

count,64-bit

integer

Implemented in ledger::core::OperationQuery.

offset()

virtual std::shared_ptr<OperationQuery> ledger::core::api::OperationQuery::offset ( int64_t  from )

pure virtual

Add offset to the operation query.

Parameters

from,64-bit

integer

Implemented in ledger::core::OperationQuery.

partial()

virtual std::shared_ptr<OperationQuery> ledger::core::api::OperationQuery::partial ( )

pure virtual

TODO

Implemented in ledger::core::OperationQuery.

---

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

• src/api/OperationQuery.hpp