NuxeoClient.Adapters.SearchAdapter Class Reference

Represents a Search Adapter, which returns paged results a . More...

Public Types
enum	SearchMode { FULLTEXT, NXQL }
	Possible search modes. More...

Public Member Functions
	SearchAdapter ()
	Initializes a new instance of SearchAdapter. More...
SearchAdapter	SetOrberBy (string orberby)
	Sets the property name by which results should be ordered. More...
SearchAdapter	SetPage (string page)
	Sets the results page to retrieve. More...
SearchAdapter	SetPageSize (string pageSize)
	Sets the size of the results page. More...
SearchAdapter	SetMaxResult (string maxResult)
	Sets the maximum number os results to retrieve. More...
SearchAdapter	SetSearchMode (SearchMode mode)
	Sets the current Search Mode. More...
SearchAdapter	SetSearchQuery (string query)
	Sets the search query, which can be full-text or NXQL. More...
Public Member Functions inherited from NuxeoClient.Adapters.Adapter
	Adapter (string id)
	Initializes a new instance of Adapter. More...
string	GetEndpointSuffix ()
	Returns the endpoint suffix to the current Adapter, to be appended to other requests. More...

Properties
SearchMode	Mode [get, protected set]
	Gets the current search mode. More...
string	SearchQuery = SearchMode.FULLTEXT [get, protected set]
	Gets the search query, which can be full-text or NXQL. More...
string	OrderBy [get, protected set]
	Gets the property by which results will be ordered. More...
string	Page = "dc:title" [get, protected set]
	Gets the results page to retrieve. More...
string	PageSize = "0" [get, protected set]
	Gets the results page size. More...
string	MaxResult = "50" [get, protected set]
	Gets the maximum number of results to retrieve. More...
QueryParams	QParams = "nolimit" [get, set]
	Gets the query parameters for this SearchAdapter. More...
Properties inherited from NuxeoClient.Adapters.Adapter
String	Id [get, protected set]
	Gets the Adapter's ID. More...
String	Parameters [get, set]
	Gets the adapter parameters to be sent on the request. More...

Detailed Description

Represents a Search Adapter, which returns paged results a .

For more details about Adapters, check Nuxeo Documentation Page.

Definition at line 25 of file SearchAdapter.cs.

Inheritance diagram for NuxeoClient.Adapters.SearchAdapter:

Member Enumeration Documentation

enum NuxeoClient.Adapters.SearchAdapter.SearchMode

strong

Possible search modes.

Definition at line 30 of file SearchAdapter.cs.

Constructor & Destructor Documentation

NuxeoClient.Adapters.SearchAdapter.SearchAdapter

(

)

Initializes a new instance of SearchAdapter.

Definition at line 73 of file SearchAdapter.cs.

Member Function Documentation

SearchAdapter NuxeoClient.Adapters.SearchAdapter.SetMaxResult

(

string

maxResult

)

Sets the maximum number os results to retrieve.

Parameters

maxResult

The maximum number os results to retrieve.

Returns

The current SearchAdapter instance.

Definition at line 121 of file SearchAdapter.cs.

SearchAdapter NuxeoClient.Adapters.SearchAdapter.SetOrberBy

(

string

orberby

)

Sets the property name by which results should be ordered.

Parameters

orberby

The property name by which results should be ordered.

Returns

The current SearchAdapter instance.

Definition at line 82 of file SearchAdapter.cs.

SearchAdapter NuxeoClient.Adapters.SearchAdapter.SetPage

(

string

page

)

Sets the results page to retrieve.

Parameters

page	The number of the results page.

Returns

The current SearchAdapter instance.

Definition at line 95 of file SearchAdapter.cs.

SearchAdapter NuxeoClient.Adapters.SearchAdapter.SetPageSize

(

string

pageSize

)

Sets the size of the results page.

Parameters

pageSize

The size of the results page.

Returns

The current SearchAdapter instance.

Definition at line 108 of file SearchAdapter.cs.

SearchAdapter NuxeoClient.Adapters.SearchAdapter.SetSearchMode

(

SearchMode

mode

)

Sets the current Search Mode.

Parameters

mode	The current search mode.

Returns

The current SearchAdapter instance.

Definition at line 134 of file SearchAdapter.cs.

SearchAdapter NuxeoClient.Adapters.SearchAdapter.SetSearchQuery

(

string

query

)

Sets the search query, which can be full-text or NXQL.

Parameters

query

The search query.

Returns

The current SearchAdapter instance.

Definition at line 145 of file SearchAdapter.cs.

Property Documentation

string NuxeoClient.Adapters.SearchAdapter.MaxResult = "50"

getprotected set

Gets the maximum number of results to retrieve.

Definition at line 63 of file SearchAdapter.cs.

SearchMode NuxeoClient.Adapters.SearchAdapter.Mode

getprotected set

Gets the current search mode.

Definition at line 38 of file SearchAdapter.cs.

string NuxeoClient.Adapters.SearchAdapter.OrderBy

getprotected set

Gets the property by which results will be ordered.

Definition at line 48 of file SearchAdapter.cs.

string NuxeoClient.Adapters.SearchAdapter.Page = "dc:title"

getprotected set

Gets the results page to retrieve.

Definition at line 53 of file SearchAdapter.cs.

string NuxeoClient.Adapters.SearchAdapter.PageSize = "0"

getprotected set

Gets the results page size.

Definition at line 58 of file SearchAdapter.cs.

QueryParams NuxeoClient.Adapters.SearchAdapter.QParams = "nolimit"

getsetprotected

Gets the query parameters for this SearchAdapter.

Definition at line 68 of file SearchAdapter.cs.

string NuxeoClient.Adapters.SearchAdapter.SearchQuery = SearchMode.FULLTEXT

getprotected set

Gets the search query, which can be full-text or NXQL.

Definition at line 43 of file SearchAdapter.cs.