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

Inheritance diagram for MixERP.Net.Api.HRM.LeaveBenefitController:

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

long	Count ()
	Counts the number of leave benefits. More...

IEnumerable< MixERP.Net.Entities.HRM.LeaveBenefit >	Get ()
	Returns collection of leave benefit for export. More...

MixERP.Net.Entities.HRM.LeaveBenefit	Get (int leaveBenefitId)
	Returns an instance of leave benefit. More...

IEnumerable< MixERP.Net.Entities.HRM.LeaveBenefit >	Get ([FromUri] int[] leaveBenefitIds)

IEnumerable< MixERP.Net.Entities.HRM.LeaveBenefit >	GetPagedResult ()
	Creates a paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId. More...

IEnumerable< MixERP.Net.Entities.HRM.LeaveBenefit >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId. More...

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

IEnumerable< MixERP.Net.Entities.HRM.LeaveBenefit >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId. More...

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

IEnumerable< MixERP.Net.Entities.HRM.LeaveBenefit >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.LeaveBenefit leaveBenefit)
	Adds your instance of LeaveBenefit class. More...

void	Edit (int leaveBenefitId, [FromBody] MixERP.Net.Entities.HRM.LeaveBenefit leaveBenefit)
	Edits existing record with your instance of LeaveBenefit class. More...

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

void	Delete (int leaveBenefitId)
	Deletes an existing instance of LeaveBenefit class via LeaveBenefitId. 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 Leave Benefits.

Member Function Documentation

void MixERP.Net.Api.HRM.LeaveBenefitController.Add ( MixERP.Net.Entities.HRM.LeaveBenefit leaveBenefit )

Adds your instance of LeaveBenefit class.

Parameters

leaveBenefit Your instance of leave benefits class to add.

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

Adds or edits your instance of LeaveBenefit class.

Parameters

leaveBenefit Your instance of leave benefits class to add or edit.

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

Adds or edits multiple instances of LeaveBenefit class.

Parameters

collection Your collection of LeaveBenefit class to bulk import.

Returns: Returns list of imported leaveBenefitIds.

Exceptions

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

long MixERP.Net.Api.HRM.LeaveBenefitController.Count ( )

Counts the number of leave benefits.

Returns: Returns the count of the leave benefits.

long MixERP.Net.Api.HRM.LeaveBenefitController.CountFiltered ( string filterName )

Counts the number of leave benefits using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered leave benefits.

long MixERP.Net.Api.HRM.LeaveBenefitController.CountWhere ( [FromBody] dynamic filters )

Counts the number of leave benefits using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered leave benefits.

void MixERP.Net.Api.HRM.LeaveBenefitController.Delete ( int leaveBenefitId )

Deletes an existing instance of LeaveBenefit class via LeaveBenefitId.

Parameters

leaveBenefitId Enter the value for LeaveBenefitId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.LeaveBenefitController.Edit	(	int	leaveBenefitId,
		[FromBody] MixERP.Net.Entities.HRM.LeaveBenefit	leaveBenefit
	)

Edits existing record with your instance of LeaveBenefit class.

Parameters

leaveBenefit	Your instance of LeaveBenefit class to edit.
leaveBenefitId	Enter the value for LeaveBenefitId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.LeaveBenefit> MixERP.Net.Api.HRM.LeaveBenefitController.Get ( )

Returns collection of leave benefit for export.

Returns

MixERP.Net.Entities.HRM.LeaveBenefit MixERP.Net.Api.HRM.LeaveBenefitController.Get ( int leaveBenefitId )

Returns an instance of leave benefit.

Parameters

leaveBenefitId Enter LeaveBenefitId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.LeaveBenefitController.GetCustomFields ( )

A custom field is a user defined field for leave benefits.

Returns: Returns an enumerable custom field collection of leave benefits.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.LeaveBenefitController.GetCustomFields ( string resourceId )

A custom field is a user defined field for leave benefits.

Returns: Returns an enumerable custom field collection of leave benefits.

IEnumerable<DisplayField> MixERP.Net.Api.HRM.LeaveBenefitController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of leave benefits.

Returns: Returns an enumerable key/value collection of leave benefits.

EntityView MixERP.Net.Api.HRM.LeaveBenefitController.GetEntityView ( )

Creates meta information of "leave benefit" entity.

Returns: Returns the "leave benefit" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.HRM.LeaveBenefit> MixERP.Net.Api.HRM.LeaveBenefitController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId.

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.HRM.LeaveBenefit> MixERP.Net.Api.HRM.LeaveBenefitController.GetPagedResult ( )

Creates a paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.LeaveBenefit> MixERP.Net.Api.HRM.LeaveBenefitController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.LeaveBenefit> MixERP.Net.Api.HRM.LeaveBenefitController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 leave benefits on each page, sorted by the property LeaveBenefitId.

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/FrontEnd/MixERP.Net.FrontEnd/Modules/HRM.API/LeaveBenefitController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation