Joutsen.Persistence.PageRequest Class Reference

A class that can be used to request a page of items from a repository. More...

Public Member Functions
	PageRequest (int pageNumber, int resultsPerPage, bool fetchTotalcount)
	Creates a new instance. More...
override bool	Equals (object obj)
override int	GetHashCode ()
PageRequest	Clone ()

Properties
int	PageNumber [get, set]
	The number of the page to retrieve. More...
int	ResultsPerPage [get, set]
	The number of results on the page. More...
int	FirstResultOfPageIndex [get]
	The absolute index of the first element on the page. More...
bool	FetchTotalCount [get, set]
	Determines if only the items on the page should be retrieved or if also the total number of items. More...

Detailed Description

A class that can be used to request a page of items from a repository.

Since

0.2.0

Constructor & Destructor Documentation

PageRequest()

Joutsen.Persistence.PageRequest.PageRequest	(	int	pageNumber,
		int	resultsPerPage,
		bool	fetchTotalcount
	)

Creates a new instance.

Parameters

pageNumber	the number of the page
resultsPerPage	the size of the page in number of items
fetchTotalcount	determines if only the items should be retrieved or if also the total number of items

Member Function Documentation

Clone()

PageRequest Joutsen.Persistence.PageRequest.Clone

(

)

Equals()

override bool Joutsen.Persistence.PageRequest.Equals

(

object

obj

)

GetHashCode()

override int Joutsen.Persistence.PageRequest.GetHashCode

(

)

Property Documentation

FetchTotalCount

bool Joutsen.Persistence.PageRequest.FetchTotalCount

getset

Determines if only the items on the page should be retrieved or if also the total number of items.

FirstResultOfPageIndex

int Joutsen.Persistence.PageRequest.FirstResultOfPageIndex

get

The absolute index of the first element on the page.

PageNumber

int Joutsen.Persistence.PageRequest.PageNumber

getset

The number of the page to retrieve.

ResultsPerPage

int Joutsen.Persistence.PageRequest.ResultsPerPage

getset

The number of results on the page.