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

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

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

long	Count ()
	Counts the number of attachment factories. More...

IEnumerable< MixERP.Net.Entities.Config.AttachmentFactory >	Get ()
	Returns collection of attachment factory for export. More...

MixERP.Net.Entities.Config.AttachmentFactory	Get (string key)
	Returns an instance of attachment factory. More...

IEnumerable< MixERP.Net.Entities.Config.AttachmentFactory >	Get ([FromUri] string[] keys)

IEnumerable< MixERP.Net.Entities.Config.AttachmentFactory >	GetPagedResult ()
	Creates a paginated collection containing 25 attachment factories on each page, sorted by the property Key. More...

IEnumerable< MixERP.Net.Entities.Config.AttachmentFactory >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 attachment factories on each page, sorted by the property Key. More...

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

IEnumerable< MixERP.Net.Entities.Config.AttachmentFactory >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 attachment factories on each page, sorted by the property Key. More...

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

IEnumerable< MixERP.Net.Entities.Config.AttachmentFactory >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 attachment factories on each page, sorted by the property Key. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Config.AttachmentFactory attachmentFactory)
	Adds your instance of AttachmentFactory class. More...

void	Edit (string key, [FromBody] MixERP.Net.Entities.Config.AttachmentFactory attachmentFactory)
	Edits existing record with your instance of AttachmentFactory class. More...

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

void	Delete (string key)
	Deletes an existing instance of AttachmentFactory 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 Attachment Factories.

Member Function Documentation

void MixERP.Net.Api.Config.AttachmentFactoryController.Add ( MixERP.Net.Entities.Config.AttachmentFactory attachmentFactory )

Adds your instance of AttachmentFactory class.

Parameters

attachmentFactory Your instance of attachment factories class to add.

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

Adds or edits your instance of AttachmentFactory class.

Parameters

attachmentFactory Your instance of attachment factories class to add or edit.

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

Adds or edits multiple instances of AttachmentFactory class.

Parameters

collection Your collection of AttachmentFactory class to bulk import.

Returns: Returns list of imported keys.

Exceptions

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

long MixERP.Net.Api.Config.AttachmentFactoryController.Count ( )

Counts the number of attachment factories.

Returns: Returns the count of the attachment factories.

long MixERP.Net.Api.Config.AttachmentFactoryController.CountFiltered ( string filterName )

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered attachment factories.

long MixERP.Net.Api.Config.AttachmentFactoryController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered attachment factories.

void MixERP.Net.Api.Config.AttachmentFactoryController.Delete ( string key )

Deletes an existing instance of AttachmentFactory class via Key.

Parameters

key	Enter the value for Key in order to find and delete the existing record.

void MixERP.Net.Api.Config.AttachmentFactoryController.Edit	(	string	key,
		[FromBody] MixERP.Net.Entities.Config.AttachmentFactory	attachmentFactory
	)

Edits existing record with your instance of AttachmentFactory class.

Parameters

attachmentFactory	Your instance of AttachmentFactory class to edit.
key	Enter the value for Key in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Config.AttachmentFactory> MixERP.Net.Api.Config.AttachmentFactoryController.Get ( )

Returns collection of attachment factory for export.

Returns

MixERP.Net.Entities.Config.AttachmentFactory MixERP.Net.Api.Config.AttachmentFactoryController.Get ( string key )

Returns an instance of attachment factory.

Parameters

key	Enter Key to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.AttachmentFactoryController.GetCustomFields ( )

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

Returns: Returns an enumerable custom field collection of attachment factories.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.AttachmentFactoryController.GetCustomFields ( string resourceId )

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

Returns: Returns an enumerable custom field collection of attachment factories.

IEnumerable<DisplayField> MixERP.Net.Api.Config.AttachmentFactoryController.GetDisplayFields ( )

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

Returns: Returns an enumerable key/value collection of attachment factories.

EntityView MixERP.Net.Api.Config.AttachmentFactoryController.GetEntityView ( )

Creates meta information of "attachment factory" entity.

Returns: Returns the "attachment factory" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Config.AttachmentFactory> MixERP.Net.Api.Config.AttachmentFactoryController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Config.AttachmentFactory> MixERP.Net.Api.Config.AttachmentFactoryController.GetPagedResult ( )

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Config.AttachmentFactory> MixERP.Net.Api.Config.AttachmentFactoryController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Config.AttachmentFactory> MixERP.Net.Api.Config.AttachmentFactoryController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Config/AttachmentFactoryController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation