MixERP.Net.Api.Config.ScrudFactoryController Class Reference

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

Inheritance diagram for MixERP.Net.Api.Config.ScrudFactoryController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "scrud factory" entity. More...
 
long Count ()
 Counts the number of scrud factories. More...
 
IEnumerable< MixERP.Net.Entities.Config.ScrudFactoryGet ()
 Returns collection of scrud factory for export. More...
 
MixERP.Net.Entities.Config.ScrudFactory Get (string key)
 Returns an instance of scrud factory. More...
 
IEnumerable< MixERP.Net.Entities.Config.ScrudFactoryGet ([FromUri] string[] keys)
 
IEnumerable< MixERP.Net.Entities.Config.ScrudFactoryGetPagedResult ()
 Creates a paginated collection containing 25 scrud factories on each page, sorted by the property Key. More...
 
IEnumerable< MixERP.Net.Entities.Config.ScrudFactoryGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 scrud factories on each page, sorted by the property Key. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of scrud factories using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Config.ScrudFactoryGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 scrud factories on each page, sorted by the property Key. More...
 
long CountFiltered (string filterName)
 Counts the number of scrud factories using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Config.ScrudFactoryGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 scrud factories on each page, sorted by the property Key. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of scrud factories. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for scrud factories. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for scrud factories. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of ScrudFactory class. More...
 
void Add (MixERP.Net.Entities.Config.ScrudFactory scrudFactory)
 Adds your instance of ScrudFactory class. More...
 
void Edit (string key, [FromBody] MixERP.Net.Entities.Config.ScrudFactory scrudFactory)
 Edits existing record with your instance of ScrudFactory class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of ScrudFactory class. More...
 
void Delete (string key)
 Deletes an existing instance of ScrudFactory class via Key. 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 Scrud Factories.

Member Function Documentation

void MixERP.Net.Api.Config.ScrudFactoryController.Add ( MixERP.Net.Entities.Config.ScrudFactory  scrudFactory)

Adds your instance of ScrudFactory class.

Parameters
scrudFactoryYour instance of scrud factories class to add.
void MixERP.Net.Api.Config.ScrudFactoryController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of ScrudFactory class.

Parameters
scrudFactoryYour instance of scrud factories class to add or edit.
List<object> MixERP.Net.Api.Config.ScrudFactoryController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of ScrudFactory class.

Parameters
collectionYour collection of ScrudFactory class to bulk import.
Returns
Returns list of imported keys.
Exceptions
MixERPExceptionThrown when your any ScrudFactory class in the collection is invalid or malformed.
long MixERP.Net.Api.Config.ScrudFactoryController.Count ( )

Counts the number of scrud factories.

Returns
Returns the count of the scrud factories.
long MixERP.Net.Api.Config.ScrudFactoryController.CountFiltered ( string  filterName)

Counts the number of scrud factories using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered scrud factories.
long MixERP.Net.Api.Config.ScrudFactoryController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of scrud factories using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered scrud factories.
void MixERP.Net.Api.Config.ScrudFactoryController.Delete ( string  key)

Deletes an existing instance of ScrudFactory class via Key.

Parameters
keyEnter the value for Key in order to find and delete the existing record.
void MixERP.Net.Api.Config.ScrudFactoryController.Edit ( string  key,
[FromBody] MixERP.Net.Entities.Config.ScrudFactory  scrudFactory 
)

Edits existing record with your instance of ScrudFactory class.

Parameters
scrudFactoryYour instance of ScrudFactory class to edit.
keyEnter the value for Key in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Config.ScrudFactory> MixERP.Net.Api.Config.ScrudFactoryController.Get ( )

Returns collection of scrud factory for export.

Returns
MixERP.Net.Entities.Config.ScrudFactory MixERP.Net.Api.Config.ScrudFactoryController.Get ( string  key)

Returns an instance of scrud factory.

Parameters
keyEnter Key to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.ScrudFactoryController.GetCustomFields ( )

A custom field is a user defined field for scrud factories.

Returns
Returns an enumerable custom field collection of scrud factories.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.ScrudFactoryController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for scrud factories.

Returns
Returns an enumerable custom field collection of scrud factories.
IEnumerable<DisplayField> MixERP.Net.Api.Config.ScrudFactoryController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of scrud factories.

Returns
Returns an enumerable key/value collection of scrud factories.
EntityView MixERP.Net.Api.Config.ScrudFactoryController.GetEntityView ( )

Creates meta information of "scrud factory" entity.

Returns
Returns the "scrud factory" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Config.ScrudFactory> MixERP.Net.Api.Config.ScrudFactoryController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 scrud factories on each page, sorted by the property Key.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Config.ScrudFactory> MixERP.Net.Api.Config.ScrudFactoryController.GetPagedResult ( )

Creates a paginated collection containing 25 scrud factories on each page, sorted by the property Key.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Config.ScrudFactory> MixERP.Net.Api.Config.ScrudFactoryController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 scrud factories on each page, sorted by the property Key.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Config.ScrudFactory> MixERP.Net.Api.Config.ScrudFactoryController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 scrud factories on each page, sorted by the property Key.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe 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: