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

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

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

long	Count ()
	Counts the number of lock outs. More...

IEnumerable< MixERP.Net.Entities.Policy.LockOut >	Get ()
	Returns collection of lock out for export. More...

MixERP.Net.Entities.Policy.LockOut	Get (long lockOutId)
	Returns an instance of lock out. More...

IEnumerable< MixERP.Net.Entities.Policy.LockOut >	Get ([FromUri] long[] lockOutIds)

IEnumerable< MixERP.Net.Entities.Policy.LockOut >	GetPagedResult ()
	Creates a paginated collection containing 25 lock outs on each page, sorted by the property LockOutId. More...

IEnumerable< MixERP.Net.Entities.Policy.LockOut >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 lock outs on each page, sorted by the property LockOutId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.LockOut lockOut)
	Adds your instance of LockOut class. More...

void	Edit (long lockOutId, [FromBody] MixERP.Net.Entities.Policy.LockOut lockOut)
	Edits existing record with your instance of LockOut class. More...

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

void	Delete (long lockOutId)
	Deletes an existing instance of LockOut class via LockOutId. 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 Lock Outs.

Member Function Documentation

void MixERP.Net.Api.Policy.LockOutController.Add ( MixERP.Net.Entities.Policy.LockOut lockOut )

Adds your instance of LockOut class.

Parameters

lockOut Your instance of lock outs class to add.

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

Adds or edits your instance of LockOut class.

Parameters

lockOut Your instance of lock outs class to add or edit.

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

Adds or edits multiple instances of LockOut class.

Parameters

collection Your collection of LockOut class to bulk import.

Returns: Returns list of imported lockOutIds.

Exceptions

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

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

Counts the number of lock outs.

Returns: Returns the count of the lock outs.

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

Counts the number of lock outs using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered lock outs.

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

Counts the number of lock outs using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered lock outs.

void MixERP.Net.Api.Policy.LockOutController.Delete ( long lockOutId )

Deletes an existing instance of LockOut class via LockOutId.

Parameters

lockOutId Enter the value for LockOutId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.LockOutController.Edit	(	long	lockOutId,
		[FromBody] MixERP.Net.Entities.Policy.LockOut	lockOut
	)

Edits existing record with your instance of LockOut class.

Parameters

lockOut	Your instance of LockOut class to edit.
lockOutId	Enter the value for LockOutId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.LockOut> MixERP.Net.Api.Policy.LockOutController.Get ( )

Returns collection of lock out for export.

Returns

MixERP.Net.Entities.Policy.LockOut MixERP.Net.Api.Policy.LockOutController.Get ( long lockOutId )

Returns an instance of lock out.

Parameters

lockOutId Enter LockOutId to search for.

Returns

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

A custom field is a user defined field for lock outs.

Returns: Returns an enumerable custom field collection of lock outs.

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

A custom field is a user defined field for lock outs.

Returns: Returns an enumerable custom field collection of lock outs.

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

Displayfield is a lightweight key/value collection of lock outs.

Returns: Returns an enumerable key/value collection of lock outs.

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

Creates meta information of "lock out" entity.

Returns: Returns the "lock out" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 lock outs on each page, sorted by the property LockOutId.

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

Creates a paginated collection containing 25 lock outs on each page, sorted by the property LockOutId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.LockOut> MixERP.Net.Api.Policy.LockOutController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 lock outs on each page, sorted by the property LockOutId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 lock outs on each page, sorted by the property LockOutId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation