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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "pay grade" entity. More...

long	Count ()
	Counts the number of pay grades. More...

IEnumerable< MixERP.Net.Entities.HRM.PayGrade >	Get ()
	Returns collection of pay grade for export. More...

MixERP.Net.Entities.HRM.PayGrade	Get (int payGradeId)
	Returns an instance of pay grade. More...

IEnumerable< MixERP.Net.Entities.HRM.PayGrade >	Get ([FromUri] int[] payGradeIds)

IEnumerable< MixERP.Net.Entities.HRM.PayGrade >	GetPagedResult ()
	Creates a paginated collection containing 25 pay grades on each page, sorted by the property PayGradeId. More...

IEnumerable< MixERP.Net.Entities.HRM.PayGrade >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 pay grades on each page, sorted by the property PayGradeId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.PayGrade payGrade)
	Adds your instance of PayGrade class. More...

void	Edit (int payGradeId, [FromBody] MixERP.Net.Entities.HRM.PayGrade payGrade)
	Edits existing record with your instance of PayGrade class. More...

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

void	Delete (int payGradeId)
	Deletes an existing instance of PayGrade class via PayGradeId. 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 Pay Grades.

Member Function Documentation

void MixERP.Net.Api.HRM.PayGradeController.Add ( MixERP.Net.Entities.HRM.PayGrade payGrade )

Adds your instance of PayGrade class.

Parameters

payGrade Your instance of pay grades class to add.

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

Adds or edits your instance of PayGrade class.

Parameters

payGrade Your instance of pay grades class to add or edit.

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

Adds or edits multiple instances of PayGrade class.

Parameters

collection Your collection of PayGrade class to bulk import.

Returns: Returns list of imported payGradeIds.

Exceptions

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

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

Counts the number of pay grades.

Returns: Returns the count of the pay grades.

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

Counts the number of pay grades using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered pay grades.

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

Counts the number of pay grades using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered pay grades.

void MixERP.Net.Api.HRM.PayGradeController.Delete ( int payGradeId )

Deletes an existing instance of PayGrade class via PayGradeId.

Parameters

payGradeId Enter the value for PayGradeId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.PayGradeController.Edit	(	int	payGradeId,
		[FromBody] MixERP.Net.Entities.HRM.PayGrade	payGrade
	)

Edits existing record with your instance of PayGrade class.

Parameters

payGrade	Your instance of PayGrade class to edit.
payGradeId	Enter the value for PayGradeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.PayGrade> MixERP.Net.Api.HRM.PayGradeController.Get ( )

Returns collection of pay grade for export.

Returns

MixERP.Net.Entities.HRM.PayGrade MixERP.Net.Api.HRM.PayGradeController.Get ( int payGradeId )

Returns an instance of pay grade.

Parameters

payGradeId Enter PayGradeId to search for.

Returns

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

A custom field is a user defined field for pay grades.

Returns: Returns an enumerable custom field collection of pay grades.

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

A custom field is a user defined field for pay grades.

Returns: Returns an enumerable custom field collection of pay grades.

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

Displayfield is a lightweight key/value collection of pay grades.

Returns: Returns an enumerable key/value collection of pay grades.

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

Creates meta information of "pay grade" entity.

Returns: Returns the "pay grade" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 pay grades on each page, sorted by the property PayGradeId.

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

Creates a paginated collection containing 25 pay grades on each page, sorted by the property PayGradeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.PayGrade> MixERP.Net.Api.HRM.PayGradeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 pay grades on each page, sorted by the property PayGradeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 pay grades on each page, sorted by the property PayGradeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation