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

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

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

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

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

MixERP.Net.Entities.Core.WidgetGroup	Get (string widgetGroupName)
	Returns an instance of widget group. More...

IEnumerable< MixERP.Net.Entities.Core.WidgetGroup >	Get ([FromUri] string[] widgetGroupNames)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.WidgetGroup widgetGroup)
	Adds your instance of WidgetGroup class. More...

void	Edit (string widgetGroupName, [FromBody] MixERP.Net.Entities.Core.WidgetGroup widgetGroup)
	Edits existing record with your instance of WidgetGroup class. More...

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

void	Delete (string widgetGroupName)
	Deletes an existing instance of WidgetGroup class via WidgetGroupName. 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 Groups.

Member Function Documentation

void MixERP.Net.Api.Core.WidgetGroupController.Add ( MixERP.Net.Entities.Core.WidgetGroup widgetGroup )

Adds your instance of WidgetGroup class.

Parameters

widgetGroup Your instance of widget groups class to add.

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

Adds or edits your instance of WidgetGroup class.

Parameters

widgetGroup Your instance of widget groups class to add or edit.

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

Adds or edits multiple instances of WidgetGroup class.

Parameters

collection Your collection of WidgetGroup class to bulk import.

Returns: Returns list of imported widgetGroupNames.

Exceptions

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

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

Counts the number of widget groups.

Returns: Returns the count of the widget groups.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered widget groups.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered widget groups.

void MixERP.Net.Api.Core.WidgetGroupController.Delete ( string widgetGroupName )

Deletes an existing instance of WidgetGroup class via WidgetGroupName.

Parameters

widgetGroupName Enter the value for WidgetGroupName in order to find and delete the existing record.

void MixERP.Net.Api.Core.WidgetGroupController.Edit	(	string	widgetGroupName,
		[FromBody] MixERP.Net.Entities.Core.WidgetGroup	widgetGroup
	)

Edits existing record with your instance of WidgetGroup class.

Parameters

widgetGroup	Your instance of WidgetGroup class to edit.
widgetGroupName	Enter the value for WidgetGroupName in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.WidgetGroup> MixERP.Net.Api.Core.WidgetGroupController.Get ( )

Returns collection of widget group for export.

Returns

MixERP.Net.Entities.Core.WidgetGroup MixERP.Net.Api.Core.WidgetGroupController.Get ( string widgetGroupName )

Returns an instance of widget group.

Parameters

widgetGroupName Enter WidgetGroupName to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "widget group" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.WidgetGroup> MixERP.Net.Api.Core.WidgetGroupController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation