NuxeoClient.Wrappers.Pageable Class Reference

Represents a pageable version of the Documents object. More...

Public Member Functions
	Pageable ()
	Initializes a new instance of Pageable. More...
Public Member Functions inherited from NuxeoClient.Wrappers.Documents
	Documents ()
	Initializes a new instance of Documents. More...
Public Member Functions inherited from NuxeoClient.Wrappers.Entity
	Entity ()
	Initializes a new instance of Entity. More...

Properties
int	TotalSize [get, set]
	Gets the total number of documents. More...
int	CurrentPageIndex = 0 [get, set]
	Gets the current page index. More...
int	CurrentPageSize = 0 [get, set]
	Gets the current page size. More...
int	MaxPageSize = 0 [get, set]
	Gets the maximum page size. More...
int	NumberOfPages = 0 [get, set]
	Gets the number of pages in the remote object. More...
int	PageSize = 0 [get, set]
	Gets the page size. More...
string	ErrorMessage = 0 [get, set]
	Gets the error message, if any. More...
bool	HasError = string.Empty [get, set]
	Gets whether there was an error or not. The error message is retrieved by ErrorMessage. More...
bool	IsLastPageAvailable = false [get, set]
	Gets whether the last page is available or not. More...
bool	IsNextPageAvailable = false [get, set]
	Gets whether the next page is available or not. More...
bool	IsPaginable = false [get, set]
	Gets whether the remote object is paginable or not. More...
bool	IsPreviousPageAvailable = false [get, set]
	Gets whether the previous page is available or not. More...
bool	IsSortable = false [get, set]
	Gets whether the remote object is sortable or not. More...
Properties inherited from NuxeoClient.Wrappers.Documents
List< Document >	Entries [get, protected set]
	Gets the list of documents. More...
Properties inherited from NuxeoClient.Wrappers.Entity
string	EntityType [get, set]
	Gets the entity type. More...

Detailed Description

Represents a pageable version of the Documents object.

Definition at line 26 of file Page.cs.

Inheritance diagram for NuxeoClient.Wrappers.Pageable:

Constructor & Destructor Documentation

NuxeoClient.Wrappers.Pageable.Pageable

(

)

Initializes a new instance of Pageable.

Definition at line 122 of file Page.cs.

Property Documentation

int NuxeoClient.Wrappers.Pageable.CurrentPageIndex = 0

getset

Gets the current page index.

Definition at line 40 of file Page.cs.

int NuxeoClient.Wrappers.Pageable.CurrentPageSize = 0

getset

Gets the current page size.

Definition at line 47 of file Page.cs.

string NuxeoClient.Wrappers.Pageable.ErrorMessage = 0

getset

Gets the error message, if any.

Definition at line 75 of file Page.cs.

bool NuxeoClient.Wrappers.Pageable.HasError = string.Empty

getset

Gets whether there was an error or not. The error message is retrieved by ErrorMessage.

Definition at line 82 of file Page.cs.

bool NuxeoClient.Wrappers.Pageable.IsLastPageAvailable = false

getset

Gets whether the last page is available or not.

Definition at line 89 of file Page.cs.

bool NuxeoClient.Wrappers.Pageable.IsNextPageAvailable = false

getset

Gets whether the next page is available or not.

Definition at line 96 of file Page.cs.

bool NuxeoClient.Wrappers.Pageable.IsPaginable = false

getset

Gets whether the remote object is paginable or not.

Definition at line 103 of file Page.cs.

bool NuxeoClient.Wrappers.Pageable.IsPreviousPageAvailable = false

getset

Gets whether the previous page is available or not.

Definition at line 110 of file Page.cs.

bool NuxeoClient.Wrappers.Pageable.IsSortable = false

getset

Gets whether the remote object is sortable or not.

Definition at line 117 of file Page.cs.

int NuxeoClient.Wrappers.Pageable.MaxPageSize = 0

getset

Gets the maximum page size.

Definition at line 54 of file Page.cs.

int NuxeoClient.Wrappers.Pageable.NumberOfPages = 0

getset

Gets the number of pages in the remote object.

Definition at line 61 of file Page.cs.

int NuxeoClient.Wrappers.Pageable.PageSize = 0

getset

Gets the page size.

Definition at line 68 of file Page.cs.

int NuxeoClient.Wrappers.Pageable.TotalSize

getset

Gets the total number of documents.

Definition at line 33 of file Page.cs.