Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Filters. More...

Inheritance diagram for MixERP.Net.Api.Core.FilterController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "filter" entity. More...

long	Count ()
	Counts the number of filters. More...

IEnumerable< MixERP.Net.Entities.Core.Filter >	Get ()
	Returns collection of filter for export. More...

MixERP.Net.Entities.Core.Filter	Get (long filterId)
	Returns an instance of filter. More...

IEnumerable< MixERP.Net.Entities.Core.Filter >	Get ([FromUri] long[] filterIds)

IEnumerable< MixERP.Net.Entities.Core.Filter >	GetPagedResult ()
	Creates a paginated collection containing 25 filters on each page, sorted by the property FilterId. More...

IEnumerable< MixERP.Net.Entities.Core.Filter >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 filters on each page, sorted by the property FilterId. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of filters using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.Core.Filter >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 filters on each page, sorted by the property FilterId. More...

long	CountFiltered (string filterName)
	Counts the number of filters using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.Core.Filter >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 filters on each page, sorted by the property FilterId. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of filters. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for filters. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for filters. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of Filter class. More...

void	Add (MixERP.Net.Entities.Core.Filter filter)
	Adds your instance of Filter class. More...

void	Edit (long filterId, [FromBody] MixERP.Net.Entities.Core.Filter filter)
	Edits existing record with your instance of Filter class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of Filter class. More...

void	Delete (long filterId)
	Deletes an existing instance of Filter class via FilterId. More...

void	RecreateFilters (string objectName, string filterName, [FromBody]dynamic collection)

void	MakeDefault (string objectName, string filterName)

void	RemoveDefault (string objectName)

Properties
long	LoginId `[get]`

int	UserId `[get]`

int	OfficeId `[get]`

string	Catalog `[get]`

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Filters.

Member Function Documentation

void MixERP.Net.Api.Core.FilterController.Add ( MixERP.Net.Entities.Core.Filter filter )

Adds your instance of Filter class.

Parameters

filter Your instance of filters class to add.

void MixERP.Net.Api.Core.FilterController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of Filter class.

Parameters

filter Your instance of filters class to add or edit.

List<object> MixERP.Net.Api.Core.FilterController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of Filter class.

Parameters

collection Your collection of Filter class to bulk import.

Returns: Returns list of imported filterIds.

Exceptions

MixERPException Thrown when your any Filter class in the collection is invalid or malformed.

long MixERP.Net.Api.Core.FilterController.Count ( )

Counts the number of filters.

Returns: Returns the count of the filters.

long MixERP.Net.Api.Core.FilterController.CountFiltered ( string filterName )

Counts the number of filters using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered filters.

long MixERP.Net.Api.Core.FilterController.CountWhere ( [FromBody] dynamic filters )

Counts the number of filters using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered filters.

void MixERP.Net.Api.Core.FilterController.Delete ( long filterId )

Deletes an existing instance of Filter class via FilterId.

Parameters

filterId Enter the value for FilterId in order to find and delete the existing record.

void MixERP.Net.Api.Core.FilterController.Edit	(	long	filterId,
		[FromBody] MixERP.Net.Entities.Core.Filter	filter
	)

Edits existing record with your instance of Filter class.

Parameters

filter	Your instance of Filter class to edit.
filterId	Enter the value for FilterId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Filter> MixERP.Net.Api.Core.FilterController.Get ( )

Returns collection of filter for export.

Returns

MixERP.Net.Entities.Core.Filter MixERP.Net.Api.Core.FilterController.Get ( long filterId )

Returns an instance of filter.

Parameters

filterId Enter FilterId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.FilterController.GetCustomFields ( )

A custom field is a user defined field for filters.

Returns: Returns an enumerable custom field collection of filters.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.FilterController.GetCustomFields ( string resourceId )

A custom field is a user defined field for filters.

Returns: Returns an enumerable custom field collection of filters.

IEnumerable<DisplayField> MixERP.Net.Api.Core.FilterController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of filters.

Returns: Returns an enumerable key/value collection of filters.

EntityView MixERP.Net.Api.Core.FilterController.GetEntityView ( )

Creates meta information of "filter" entity.

Returns: Returns the "filter" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Core.Filter> MixERP.Net.Api.Core.FilterController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 filters on each page, sorted by the property FilterId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.Core.Filter> MixERP.Net.Api.Core.FilterController.GetPagedResult ( )

Creates a paginated collection containing 25 filters on each page, sorted by the property FilterId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Filter> MixERP.Net.Api.Core.FilterController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 filters on each page, sorted by the property FilterId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Filter> MixERP.Net.Api.Core.FilterController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 filters on each page, sorted by the property FilterId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The list of filter conditions.

Returns: Returns the requested page from the collection using the supplied filters.

The documentation for this class was generated from the following file:

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/Web API/Core/FilterController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation