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

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

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

long	Count ()
	Counts the number of terminations. More...

IEnumerable< MixERP.Net.Entities.HRM.Termination >	Get ()
	Returns collection of termination for export. More...

MixERP.Net.Entities.HRM.Termination	Get (int terminationId)
	Returns an instance of termination. More...

IEnumerable< MixERP.Net.Entities.HRM.Termination >	Get ([FromUri] int[] terminationIds)

IEnumerable< MixERP.Net.Entities.HRM.Termination >	GetPagedResult ()
	Creates a paginated collection containing 25 terminations on each page, sorted by the property TerminationId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.Termination termination)
	Adds your instance of Termination class. More...

void	Edit (int terminationId, [FromBody] MixERP.Net.Entities.HRM.Termination termination)
	Edits existing record with your instance of Termination class. More...

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

void	Delete (int terminationId)
	Deletes an existing instance of Termination class via TerminationId. 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 Terminations.

Member Function Documentation

void MixERP.Net.Api.HRM.TerminationController.Add ( MixERP.Net.Entities.HRM.Termination termination )

Adds your instance of Termination class.

Parameters

termination Your instance of terminations class to add.

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

Adds or edits your instance of Termination class.

Parameters

termination Your instance of terminations class to add or edit.

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

Adds or edits multiple instances of Termination class.

Parameters

collection Your collection of Termination class to bulk import.

Returns: Returns list of imported terminationIds.

Exceptions

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

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

Counts the number of terminations.

Returns: Returns the count of the terminations.

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

Counts the number of terminations using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered terminations.

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

Counts the number of terminations using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered terminations.

void MixERP.Net.Api.HRM.TerminationController.Delete ( int terminationId )

Deletes an existing instance of Termination class via TerminationId.

Parameters

terminationId Enter the value for TerminationId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.TerminationController.Edit	(	int	terminationId,
		[FromBody] MixERP.Net.Entities.HRM.Termination	termination
	)

Edits existing record with your instance of Termination class.

Parameters

termination	Your instance of Termination class to edit.
terminationId	Enter the value for TerminationId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.Termination> MixERP.Net.Api.HRM.TerminationController.Get ( )

Returns collection of termination for export.

Returns

MixERP.Net.Entities.HRM.Termination MixERP.Net.Api.HRM.TerminationController.Get ( int terminationId )

Returns an instance of termination.

Parameters

terminationId Enter TerminationId to search for.

Returns

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

A custom field is a user defined field for terminations.

Returns: Returns an enumerable custom field collection of terminations.

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

A custom field is a user defined field for terminations.

Returns: Returns an enumerable custom field collection of terminations.

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

Displayfield is a lightweight key/value collection of terminations.

Returns: Returns an enumerable key/value collection of terminations.

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

Creates meta information of "termination" entity.

Returns: Returns the "termination" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 terminations on each page, sorted by the property TerminationId.

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

Creates a paginated collection containing 25 terminations on each page, sorted by the property TerminationId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Termination> MixERP.Net.Api.HRM.TerminationController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 terminations on each page, sorted by the property TerminationId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 terminations on each page, sorted by the property TerminationId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation