Pip-Services-Commons-Dotnet
|
Data transfer object that is used to pass results of paginated queries. It contains items of retrieved page and optional total number of items. More...
Public Member Functions | |
DataPage () | |
Creates a new instance of data page. More... | |
DataPage (List< T > data, long? total=null) | |
Creates a new instance of data page and assigns its values. More... | |
Properties | |
long | Total [get, set] |
List< T > | Data [get, set] |
Data transfer object that is used to pass results of paginated queries. It contains items of retrieved page and optional total number of items.
Most often this object type is used to send responses to paginated queries. Pagination parameters are defined by PagingParams object. The skip
parameter in the PagingParams there means how many items to skip. The takes
parameter sets number of items to return in the page. And the optional total
parameter tells to return total number of items in the query.
Remember: not all implementations support total
parameter because its generation may lead to severe performance implications.
T | the class type |
See PagingParams
Creates a new instance of data page.
PipServices3.Commons.Data.DataPage< T >.DataPage | ( | List< T > | data, |
long? | total = null |
||
) |
Creates a new instance of data page and assigns its values.
data | a list of items from the retrieved page. |
total | (optional) . |
|
getset |
The items of the retrieved page.
|
getset |
The total amount of items in a request.