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

Inheritance diagram for MixERP.Net.Api.Policy.MenuAccessController:

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

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

IEnumerable< MixERP.Net.Entities.Policy.MenuAccess >	Get ()
	Returns collection of menu access for export. More...

MixERP.Net.Entities.Policy.MenuAccess	Get (long accessId)
	Returns an instance of menu access. More...

IEnumerable< MixERP.Net.Entities.Policy.MenuAccess >	Get ([FromUri] long[] accessIds)

IEnumerable< MixERP.Net.Entities.Policy.MenuAccess >	GetPagedResult ()
	Creates a paginated collection containing 25 menu accesses on each page, sorted by the property AccessId. More...

IEnumerable< MixERP.Net.Entities.Policy.MenuAccess >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 menu accesses on each page, sorted by the property AccessId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.MenuAccess menuAccess)
	Adds your instance of MenuAccess class. More...

void	Edit (long accessId, [FromBody] MixERP.Net.Entities.Policy.MenuAccess menuAccess)
	Edits existing record with your instance of MenuAccess class. More...

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

void	Delete (long accessId)
	Deletes an existing instance of MenuAccess class via AccessId. 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 Accesses.

Member Function Documentation

void MixERP.Net.Api.Policy.MenuAccessController.Add ( MixERP.Net.Entities.Policy.MenuAccess menuAccess )

Adds your instance of MenuAccess class.

Parameters

menuAccess Your instance of menu accesses class to add.

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

Adds or edits your instance of MenuAccess class.

Parameters

menuAccess Your instance of menu accesses class to add or edit.

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

Adds or edits multiple instances of MenuAccess class.

Parameters

collection Your collection of MenuAccess class to bulk import.

Returns: Returns list of imported accessIds.

Exceptions

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

long MixERP.Net.Api.Policy.MenuAccessController.Count ( )

Counts the number of menu accesses.

Returns: Returns the count of the menu accesses.

long MixERP.Net.Api.Policy.MenuAccessController.CountFiltered ( string filterName )

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered menu accesses.

long MixERP.Net.Api.Policy.MenuAccessController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered menu accesses.

void MixERP.Net.Api.Policy.MenuAccessController.Delete ( long accessId )

Deletes an existing instance of MenuAccess class via AccessId.

Parameters

accessId Enter the value for AccessId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.MenuAccessController.Edit	(	long	accessId,
		[FromBody] MixERP.Net.Entities.Policy.MenuAccess	menuAccess
	)

Edits existing record with your instance of MenuAccess class.

Parameters

menuAccess	Your instance of MenuAccess class to edit.
accessId	Enter the value for AccessId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.MenuAccess> MixERP.Net.Api.Policy.MenuAccessController.Get ( )

Returns collection of menu access for export.

Returns

MixERP.Net.Entities.Policy.MenuAccess MixERP.Net.Api.Policy.MenuAccessController.Get ( long accessId )

Returns an instance of menu access.

Parameters

accessId Enter AccessId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.MenuAccessController.GetCustomFields ( )

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

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

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.MenuAccessController.GetCustomFields ( string resourceId )

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

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

IEnumerable<DisplayField> MixERP.Net.Api.Policy.MenuAccessController.GetDisplayFields ( )

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

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

EntityView MixERP.Net.Api.Policy.MenuAccessController.GetEntityView ( )

Creates meta information of "menu access" entity.

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

IEnumerable<MixERP.Net.Entities.Policy.MenuAccess> MixERP.Net.Api.Policy.MenuAccessController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Policy.MenuAccess> MixERP.Net.Api.Policy.MenuAccessController.GetPagedResult ( )

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.MenuAccess> MixERP.Net.Api.Policy.MenuAccessController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.MenuAccess> MixERP.Net.Api.Policy.MenuAccessController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Policy/MenuAccessController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation