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

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

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

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

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

MixERP.Net.Entities.Policy.EntityAccess	Get (int entityAccessId)
	Returns an instance of entity access. More...

IEnumerable< MixERP.Net.Entities.Policy.EntityAccess >	Get ([FromUri] int[] entityAccessIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.EntityAccess entityAccess)
	Adds your instance of EntityAccess class. More...

void	Edit (int entityAccessId, [FromBody] MixERP.Net.Entities.Policy.EntityAccess entityAccess)
	Edits existing record with your instance of EntityAccess class. More...

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

void	Delete (int entityAccessId)
	Deletes an existing instance of EntityAccess class via EntityAccessId. 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 Entity Accesses.

Member Function Documentation

void MixERP.Net.Api.Policy.EntityAccessController.Add ( MixERP.Net.Entities.Policy.EntityAccess entityAccess )

Adds your instance of EntityAccess class.

Parameters

entityAccess Your instance of entity accesses class to add.

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

Adds or edits your instance of EntityAccess class.

Parameters

entityAccess Your instance of entity accesses class to add or edit.

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

Adds or edits multiple instances of EntityAccess class.

Parameters

collection Your collection of EntityAccess class to bulk import.

Returns: Returns list of imported entityAccessIds.

Exceptions

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

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

Counts the number of entity accesses.

Returns: Returns the count of the entity accesses.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered entity accesses.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered entity accesses.

void MixERP.Net.Api.Policy.EntityAccessController.Delete ( int entityAccessId )

Deletes an existing instance of EntityAccess class via EntityAccessId.

Parameters

entityAccessId Enter the value for EntityAccessId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.EntityAccessController.Edit	(	int	entityAccessId,
		[FromBody] MixERP.Net.Entities.Policy.EntityAccess	entityAccess
	)

Edits existing record with your instance of EntityAccess class.

Parameters

entityAccess	Your instance of EntityAccess class to edit.
entityAccessId	Enter the value for EntityAccessId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.EntityAccess> MixERP.Net.Api.Policy.EntityAccessController.Get ( )

Returns collection of entity access for export.

Returns

MixERP.Net.Entities.Policy.EntityAccess MixERP.Net.Api.Policy.EntityAccessController.Get ( int entityAccessId )

Returns an instance of entity access.

Parameters

entityAccessId Enter EntityAccessId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "entity access" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.EntityAccess> MixERP.Net.Api.Policy.EntityAccessController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation