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

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

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

long	Count ()
	Counts the number of widget setups. More...

IEnumerable< MixERP.Net.Entities.Core.WidgetSetup >	Get ()
	Returns collection of widget setup for export. More...

MixERP.Net.Entities.Core.WidgetSetup	Get (int widgetSetupId)
	Returns an instance of widget setup. More...

IEnumerable< MixERP.Net.Entities.Core.WidgetSetup >	Get ([FromUri] int[] widgetSetupIds)

IEnumerable< MixERP.Net.Entities.Core.WidgetSetup >	GetPagedResult ()
	Creates a paginated collection containing 25 widget setups on each page, sorted by the property WidgetSetupId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.WidgetSetup widgetSetup)
	Adds your instance of WidgetSetup class. More...

void	Edit (int widgetSetupId, [FromBody] MixERP.Net.Entities.Core.WidgetSetup widgetSetup)
	Edits existing record with your instance of WidgetSetup class. More...

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

void	Delete (int widgetSetupId)
	Deletes an existing instance of WidgetSetup class via WidgetSetupId. More...

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 Widget Setups.

Member Function Documentation

void MixERP.Net.Api.Core.WidgetSetupController.Add ( MixERP.Net.Entities.Core.WidgetSetup widgetSetup )

Adds your instance of WidgetSetup class.

Parameters

widgetSetup Your instance of widget setups class to add.

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

Adds or edits your instance of WidgetSetup class.

Parameters

widgetSetup Your instance of widget setups class to add or edit.

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

Adds or edits multiple instances of WidgetSetup class.

Parameters

collection Your collection of WidgetSetup class to bulk import.

Returns: Returns list of imported widgetSetupIds.

Exceptions

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

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

Counts the number of widget setups.

Returns: Returns the count of the widget setups.

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

Counts the number of widget setups using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered widget setups.

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

Counts the number of widget setups using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered widget setups.

void MixERP.Net.Api.Core.WidgetSetupController.Delete ( int widgetSetupId )

Deletes an existing instance of WidgetSetup class via WidgetSetupId.

Parameters

widgetSetupId Enter the value for WidgetSetupId in order to find and delete the existing record.

void MixERP.Net.Api.Core.WidgetSetupController.Edit	(	int	widgetSetupId,
		[FromBody] MixERP.Net.Entities.Core.WidgetSetup	widgetSetup
	)

Edits existing record with your instance of WidgetSetup class.

Parameters

widgetSetup	Your instance of WidgetSetup class to edit.
widgetSetupId	Enter the value for WidgetSetupId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.WidgetSetup> MixERP.Net.Api.Core.WidgetSetupController.Get ( )

Returns collection of widget setup for export.

Returns

MixERP.Net.Entities.Core.WidgetSetup MixERP.Net.Api.Core.WidgetSetupController.Get ( int widgetSetupId )

Returns an instance of widget setup.

Parameters

widgetSetupId Enter WidgetSetupId to search for.

Returns

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

A custom field is a user defined field for widget setups.

Returns: Returns an enumerable custom field collection of widget setups.

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

A custom field is a user defined field for widget setups.

Returns: Returns an enumerable custom field collection of widget setups.

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

Displayfield is a lightweight key/value collection of widget setups.

Returns: Returns an enumerable key/value collection of widget setups.

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

Creates meta information of "widget setup" entity.

Returns: Returns the "widget setup" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 widget setups on each page, sorted by the property WidgetSetupId.

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.WidgetSetup> MixERP.Net.Api.Core.WidgetSetupController.GetPagedResult ( )

Creates a paginated collection containing 25 widget setups on each page, sorted by the property WidgetSetupId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.WidgetSetup> MixERP.Net.Api.Core.WidgetSetupController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 widget setups on each page, sorted by the property WidgetSetupId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 widget setups on each page, sorted by the property WidgetSetupId.

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/WidgetSetupController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation