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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "salary frequency" entity. More...

long	Count ()
	Counts the number of salary frequencies. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryFrequency >	Get ()
	Returns collection of salary frequency for export. More...

MixERP.Net.Entities.HRM.SalaryFrequency	Get (int salaryFrequencyId)
	Returns an instance of salary frequency. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryFrequency >	Get ([FromUri] int[] salaryFrequencyIds)

IEnumerable< MixERP.Net.Entities.HRM.SalaryFrequency >	GetPagedResult ()
	Creates a paginated collection containing 25 salary frequencies on each page, sorted by the property SalaryFrequencyId. More...

IEnumerable< MixERP.Net.Entities.HRM.SalaryFrequency >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 salary frequencies on each page, sorted by the property SalaryFrequencyId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.SalaryFrequency salaryFrequency)
	Adds your instance of SalaryFrequency class. More...

void	Edit (int salaryFrequencyId, [FromBody] MixERP.Net.Entities.HRM.SalaryFrequency salaryFrequency)
	Edits existing record with your instance of SalaryFrequency class. More...

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

void	Delete (int salaryFrequencyId)
	Deletes an existing instance of SalaryFrequency class via SalaryFrequencyId. 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 Salary Frequencies.

Member Function Documentation

void MixERP.Net.Api.HRM.SalaryFrequencyController.Add ( MixERP.Net.Entities.HRM.SalaryFrequency salaryFrequency )

Adds your instance of SalaryFrequency class.

Parameters

salaryFrequency Your instance of salary frequencies class to add.

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

Adds or edits your instance of SalaryFrequency class.

Parameters

salaryFrequency Your instance of salary frequencies class to add or edit.

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

Adds or edits multiple instances of SalaryFrequency class.

Parameters

collection Your collection of SalaryFrequency class to bulk import.

Returns: Returns list of imported salaryFrequencyIds.

Exceptions

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

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

Counts the number of salary frequencies.

Returns: Returns the count of the salary frequencies.

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

Counts the number of salary frequencies using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered salary frequencies.

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

Counts the number of salary frequencies using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered salary frequencies.

void MixERP.Net.Api.HRM.SalaryFrequencyController.Delete ( int salaryFrequencyId )

Deletes an existing instance of SalaryFrequency class via SalaryFrequencyId.

Parameters

salaryFrequencyId Enter the value for SalaryFrequencyId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.SalaryFrequencyController.Edit	(	int	salaryFrequencyId,
		[FromBody] MixERP.Net.Entities.HRM.SalaryFrequency	salaryFrequency
	)

Edits existing record with your instance of SalaryFrequency class.

Parameters

salaryFrequency	Your instance of SalaryFrequency class to edit.
salaryFrequencyId	Enter the value for SalaryFrequencyId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.SalaryFrequency> MixERP.Net.Api.HRM.SalaryFrequencyController.Get ( )

Returns collection of salary frequency for export.

Returns

MixERP.Net.Entities.HRM.SalaryFrequency MixERP.Net.Api.HRM.SalaryFrequencyController.Get ( int salaryFrequencyId )

Returns an instance of salary frequency.

Parameters

salaryFrequencyId Enter SalaryFrequencyId to search for.

Returns

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

A custom field is a user defined field for salary frequencies.

Returns: Returns an enumerable custom field collection of salary frequencies.

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

A custom field is a user defined field for salary frequencies.

Returns: Returns an enumerable custom field collection of salary frequencies.

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

Displayfield is a lightweight key/value collection of salary frequencies.

Returns: Returns an enumerable key/value collection of salary frequencies.

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

Creates meta information of "salary frequency" entity.

Returns: Returns the "salary frequency" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 salary frequencies on each page, sorted by the property SalaryFrequencyId.

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

Creates a paginated collection containing 25 salary frequencies on each page, sorted by the property SalaryFrequencyId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.SalaryFrequency> MixERP.Net.Api.HRM.SalaryFrequencyController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 salary frequencies on each page, sorted by the property SalaryFrequencyId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 salary frequencies on each page, sorted by the property SalaryFrequencyId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation