libSmalldb  v0.7-37-g795340f
Public Member Functions | Public Attributes | List of all members
IListing Interface Reference

Description

A prefered way to retrieve list of existing state machine instances.

Listing is created by AbstractMachine::createListing method, it should not be created directly.

Inheritance diagram for IListing

Public Member Functions

 query ()
 Execute SQL query or do whatever is required to get this listing populated. More...
 
 describeProperties ()
 Get description of all properties (columns) in the listing. More...
 
 fetchAll ()
 Returns an array of all items in the listing. More...
 
 getProcessedFilters ()
 Get filter configuration (processed and filled with pagination data). More...
 

Public Attributes

const IGNORE_UNKNOWN_FILTERS = 0x0100
 Filtering flag: If there are unknown filters, no exception will be thrown by constructor. More...
 

Member Function Documentation

◆ query()

query ( )

Execute SQL query or do whatever is required to get this listing populated.

Implemented in FlupdoGenericListing.

◆ describeProperties()

describeProperties ( )

Get description of all properties (columns) in the listing.

Implemented in FlupdoGenericListing.

◆ fetchAll()

fetchAll ( )

Returns an array of all items in the listing.

Implemented in FlupdoGenericListing.

◆ getProcessedFilters()

getProcessedFilters ( )

Get filter configuration (processed and filled with pagination data).

This method should be called after query().

Implemented in FlupdoGenericListing.

Member Data Documentation

◆ IGNORE_UNKNOWN_FILTERS

const IGNORE_UNKNOWN_FILTERS = 0x0100

Filtering flag: If there are unknown filters, no exception will be thrown by constructor.