Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Store Policy Details. More...

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "store policy detail" entity. More...

long	Count ()
	Counts the number of store policy details. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicyDetail >	Get ()
	Returns collection of store policy detail for export. More...

MixERP.Net.Entities.Policy.StorePolicyDetail	Get (long storePolicyDetailId)
	Returns an instance of store policy detail. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicyDetail >	Get ([FromUri] long[] storePolicyDetailIds)

IEnumerable< MixERP.Net.Entities.Policy.StorePolicyDetail >	GetPagedResult ()
	Creates a paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicyDetail >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of store policy details using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicyDetail >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId. More...

long	CountFiltered (string filterName)
	Counts the number of store policy details using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicyDetail >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of store policy details. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for store policy details. More...

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

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

void	Add (MixERP.Net.Entities.Policy.StorePolicyDetail storePolicyDetail)
	Adds your instance of StorePolicyDetail class. More...

void	Edit (long storePolicyDetailId, [FromBody] MixERP.Net.Entities.Policy.StorePolicyDetail storePolicyDetail)
	Edits existing record with your instance of StorePolicyDetail class. More...

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

void	Delete (long storePolicyDetailId)
	Deletes an existing instance of StorePolicyDetail class via StorePolicyDetailId. 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 Store Policy Details.

Member Function Documentation

void MixERP.Net.Api.Policy.StorePolicyDetailController.Add ( MixERP.Net.Entities.Policy.StorePolicyDetail storePolicyDetail )

Adds your instance of StorePolicyDetail class.

Parameters

storePolicyDetail Your instance of store policy details class to add.

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

Adds or edits your instance of StorePolicyDetail class.

Parameters

storePolicyDetail Your instance of store policy details class to add or edit.

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

Adds or edits multiple instances of StorePolicyDetail class.

Parameters

collection Your collection of StorePolicyDetail class to bulk import.

Returns: Returns list of imported storePolicyDetailIds.

Exceptions

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

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

Counts the number of store policy details.

Returns: Returns the count of the store policy details.

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

Counts the number of store policy details using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered store policy details.

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

Counts the number of store policy details using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered store policy details.

void MixERP.Net.Api.Policy.StorePolicyDetailController.Delete ( long storePolicyDetailId )

Deletes an existing instance of StorePolicyDetail class via StorePolicyDetailId.

Parameters

storePolicyDetailId Enter the value for StorePolicyDetailId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.StorePolicyDetailController.Edit	(	long	storePolicyDetailId,
		[FromBody] MixERP.Net.Entities.Policy.StorePolicyDetail	storePolicyDetail
	)

Edits existing record with your instance of StorePolicyDetail class.

Parameters

storePolicyDetail	Your instance of StorePolicyDetail class to edit.
storePolicyDetailId	Enter the value for StorePolicyDetailId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.StorePolicyDetail> MixERP.Net.Api.Policy.StorePolicyDetailController.Get ( )

Returns collection of store policy detail for export.

Returns

MixERP.Net.Entities.Policy.StorePolicyDetail MixERP.Net.Api.Policy.StorePolicyDetailController.Get ( long storePolicyDetailId )

Returns an instance of store policy detail.

Parameters

storePolicyDetailId Enter StorePolicyDetailId to search for.

Returns

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

A custom field is a user defined field for store policy details.

Returns: Returns an enumerable custom field collection of store policy details.

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

A custom field is a user defined field for store policy details.

Returns: Returns an enumerable custom field collection of store policy details.

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

Displayfield is a lightweight key/value collection of store policy details.

Returns: Returns an enumerable key/value collection of store policy details.

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

Creates meta information of "store policy detail" entity.

Returns: Returns the "store policy detail" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId.

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

Creates a paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.StorePolicyDetail> MixERP.Net.Api.Policy.StorePolicyDetailController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 store policy details on each page, sorted by the property StorePolicyDetailId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation