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

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

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

long	Count ()
	Counts the number of menu locales. More...

IEnumerable< MixERP.Net.Entities.Core.MenuLocale >	Get ()
	Returns collection of menu locale for export. More...

MixERP.Net.Entities.Core.MenuLocale	Get (int menuLocaleId)
	Returns an instance of menu locale. More...

IEnumerable< MixERP.Net.Entities.Core.MenuLocale >	Get ([FromUri] int[] menuLocaleIds)

IEnumerable< MixERP.Net.Entities.Core.MenuLocale >	GetPagedResult ()
	Creates a paginated collection containing 25 menu locales on each page, sorted by the property MenuLocaleId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.MenuLocale menuLocale)
	Adds your instance of MenuLocale class. More...

void	Edit (int menuLocaleId, [FromBody] MixERP.Net.Entities.Core.MenuLocale menuLocale)
	Edits existing record with your instance of MenuLocale class. More...

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

void	Delete (int menuLocaleId)
	Deletes an existing instance of MenuLocale class via MenuLocaleId. 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 Menu Locales.

Member Function Documentation

void MixERP.Net.Api.Core.MenuLocaleController.Add ( MixERP.Net.Entities.Core.MenuLocale menuLocale )

Adds your instance of MenuLocale class.

Parameters

menuLocale Your instance of menu locales class to add.

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

Adds or edits your instance of MenuLocale class.

Parameters

menuLocale Your instance of menu locales class to add or edit.

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

Adds or edits multiple instances of MenuLocale class.

Parameters

collection Your collection of MenuLocale class to bulk import.

Returns: Returns list of imported menuLocaleIds.

Exceptions

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

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

Counts the number of menu locales.

Returns: Returns the count of the menu locales.

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

Counts the number of menu locales using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered menu locales.

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

Counts the number of menu locales using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered menu locales.

void MixERP.Net.Api.Core.MenuLocaleController.Delete ( int menuLocaleId )

Deletes an existing instance of MenuLocale class via MenuLocaleId.

Parameters

menuLocaleId Enter the value for MenuLocaleId in order to find and delete the existing record.

void MixERP.Net.Api.Core.MenuLocaleController.Edit	(	int	menuLocaleId,
		[FromBody] MixERP.Net.Entities.Core.MenuLocale	menuLocale
	)

Edits existing record with your instance of MenuLocale class.

Parameters

menuLocale	Your instance of MenuLocale class to edit.
menuLocaleId	Enter the value for MenuLocaleId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.MenuLocale> MixERP.Net.Api.Core.MenuLocaleController.Get ( )

Returns collection of menu locale for export.

Returns

MixERP.Net.Entities.Core.MenuLocale MixERP.Net.Api.Core.MenuLocaleController.Get ( int menuLocaleId )

Returns an instance of menu locale.

Parameters

menuLocaleId Enter MenuLocaleId to search for.

Returns

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

A custom field is a user defined field for menu locales.

Returns: Returns an enumerable custom field collection of menu locales.

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

A custom field is a user defined field for menu locales.

Returns: Returns an enumerable custom field collection of menu locales.

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

Displayfield is a lightweight key/value collection of menu locales.

Returns: Returns an enumerable key/value collection of menu locales.

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

Creates meta information of "menu locale" entity.

Returns: Returns the "menu locale" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 menu locales on each page, sorted by the property MenuLocaleId.

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

Creates a paginated collection containing 25 menu locales on each page, sorted by the property MenuLocaleId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.MenuLocale> MixERP.Net.Api.Core.MenuLocaleController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 menu locales on each page, sorted by the property MenuLocaleId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 menu locales on each page, sorted by the property MenuLocaleId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation